Author: ivaynberg
Date: Mon Nov 20 09:33:06 2006
New Revision: 477265
URL: http://svn.apache.org/viewvc?view=rev&rev=477265
Log:
WICKET-35: append AjaxTimerBehavior script to component markup. the unit test
is failing because header contributions does not filter doubles.
Added:
incubator/wicket/trunk/wicket/src/test/java/wicket/ajax/AjaxTimerBehaviorTest.java
Modified:
incubator/wicket/trunk/wicket/src/main/java/wicket/ajax/AbstractAjaxTimerBehavior.java
Modified:
incubator/wicket/trunk/wicket/src/main/java/wicket/ajax/AbstractAjaxTimerBehavior.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/trunk/wicket/src/main/java/wicket/ajax/AbstractAjaxTimerBehavior.java?view=diff&rev=477265&r1=477264&r2=477265
==============================================================================
---
incubator/wicket/trunk/wicket/src/main/java/wicket/ajax/AbstractAjaxTimerBehavior.java
(original)
+++
incubator/wicket/trunk/wicket/src/main/java/wicket/ajax/AbstractAjaxTimerBehavior.java
Mon Nov 20 09:33:06 2006
@@ -16,8 +16,10 @@
*/
package wicket.ajax;
+import wicket.RequestCycle;
import wicket.markup.html.IHeaderResponse;
import wicket.markup.html.WebPage;
+import wicket.util.string.JavascriptUtils;
import wicket.util.time.Duration;
/**
@@ -64,13 +66,6 @@
public void renderHead(IHeaderResponse response)
{
super.renderHead(response);
-
- if (this.attachedBodyOnLoadModifier == false)
- {
- this.attachedBodyOnLoadModifier = true;
-
((WebPage)getComponent().getPage()).getBodyContainer().addOnLoadModifier(
- getJsTimeoutCall(updateInterval),
getComponent());
- }
}
/**
@@ -92,7 +87,6 @@
protected final void respond(final AjaxRequestTarget target)
{
onTimer(target);
- target.appendJavascript(getJsTimeoutCall(updateInterval));
}
/**
@@ -102,4 +96,14 @@
* The request target
*/
protected abstract void onTimer(final AjaxRequestTarget target);
+
+ /**
+ * Inject the timer script into the markup after the component is
rendered
+ * @see wicket.behavior.AbstractAjaxBehavior#onComponentRendered()
+ */
+ @Override
+ protected void onComponentRendered()
+ {
+
JavascriptUtils.writeJavascript(RequestCycle.get().getResponse(),
getJsTimeoutCall(updateInterval));
+ }
}
Added:
incubator/wicket/trunk/wicket/src/test/java/wicket/ajax/AjaxTimerBehaviorTest.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/trunk/wicket/src/test/java/wicket/ajax/AjaxTimerBehaviorTest.java?view=auto&rev=477265
==============================================================================
---
incubator/wicket/trunk/wicket/src/test/java/wicket/ajax/AjaxTimerBehaviorTest.java
(added)
+++
incubator/wicket/trunk/wicket/src/test/java/wicket/ajax/AjaxTimerBehaviorTest.java
Mon Nov 20 09:33:06 2006
@@ -0,0 +1,209 @@
+/*
+ * $Id: org.eclipse.jdt.ui.prefs 5004 2006-03-17 20:47:08 -0800 (Fri, 17 Mar
2006) eelco12 $
+ * $Revision: 5004 $
+ * $Date: 2006-03-17 20:47:08 -0800 (Fri, 17 Mar 2006) $
+ *
+ *
==============================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy
of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
under
+ * the License.
+ */
+package wicket.ajax;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+import wicket.MockPageWithLinkAndComponent;
+import wicket.MockPageWithOneComponent;
+import wicket.Page;
+import wicket.WicketTestCase;
+import wicket.ajax.markup.html.AjaxLink;
+import wicket.markup.html.WebComponent;
+import wicket.markup.html.WebMarkupContainer;
+import wicket.markup.html.basic.Label;
+import wicket.protocol.http.WebRequestCycle;
+import wicket.util.tester.ITestPageSource;
+import wicket.util.time.Duration;
+
+/**
+ * Tests that an AbstractAjaxTimerBehavior injects itself into the markup once
+ * and only once. Also tests the callback URL to make sure the timer reinjects
+ * itself
+ *
+ * @author Jim McLaughlin
+ */
+public class AjaxTimerBehaviorTest extends WicketTestCase
+{
+ private static final Log log =
LogFactory.getLog(AjaxTimerBehaviorTest.class);
+
+ /**
+ * Tests timer behavior in a component added to an AjaxRequestTarget
+ */
+ public void testAddToAjaxUpdate()
+ {
+ Duration dur = Duration.seconds(20);
+ final MyAjaxSelfUpdatingTimerBehavior timer = new
MyAjaxSelfUpdatingTimerBehavior(dur);
+ final MockPageWithLinkAndComponent page = new
MockPageWithLinkAndComponent();
+
+ new WebComponent(page,
MockPageWithLinkAndComponent.COMPONENT_ID).setOutputMarkupId(true);
+
+
+ new AjaxLink(page, MockPageWithLinkAndComponent.LINK_ID)
+ {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public void onClick(AjaxRequestTarget target)
+ {
+ WebMarkupContainer wmc = new
WebMarkupContainer(page,
+
MockPageWithLinkAndComponent.COMPONENT_ID);
+ wmc.setOutputMarkupId(true);
+ wmc.add(timer);
+ target.addComponent(wmc);
+ }
+ };
+
+ tester.startPage(new ITestPageSource()
+ {
+ private static final long serialVersionUID = 1L;
+
+ public Page getTestPage()
+ {
+ return page;
+ }
+ });
+
+ tester.clickLink(MockPageWithLinkAndComponent.LINK_ID);
+
+ validate(timer);
+
+ }
+
+
+ /**
+ * tests timer behavior in a WebPage.
+ */
+ public void testAddToWebPage()
+ {
+ Duration dur = Duration.seconds(20);
+ final MyAjaxSelfUpdatingTimerBehavior timer = new
MyAjaxSelfUpdatingTimerBehavior(dur);
+ final MockPageWithOneComponent page = new
MockPageWithOneComponent();
+ Label label = new Label(page,
MockPageWithOneComponent.COMPONENT_ID, "Hello");
+ label.setOutputMarkupId(true);
+ label.add(timer);
+
+ tester.startPage(new ITestPageSource()
+ {
+ private static final long serialVersionUID = 1L;
+
+ public Page getTestPage()
+ {
+ return page;
+ }
+ });
+
+ validate(timer);
+
+ }
+
+ /**
+ * Validates the reponse, then makes sure the timer injects itself again
+ * when called.
+ *
+ * @param timer
+ */
+ private void validate(MyAjaxSelfUpdatingTimerBehavior timer)
+ {
+ String document = tester.getServletResponse().getDocument();
+
+ String updateScript = timer.getUpdateScript();
+
+ validateTimerScript(document, updateScript);
+
+
+ tester.setupRequestAndResponse();
+ WebRequestCycle cycle = tester.createRequestCycle();
+ String url = timer.getCallbackUrl().toString();
+ tester.getServletRequest().setRequestToRedirectString(url);
+
+ tester.processRequestCycle(cycle);
+
+ // Validate the document
+ document = tester.getServletResponse().getDocument();
+ validateTimerScript(document, updateScript);
+ }
+
+ /**
+ * Checks that the timer javascript is in the document once and only
once
+ *
+ * @param document
+ * the response from the Application
+ * @param updateScript
+ * the timer script
+ */
+ private void validateTimerScript(String document, String updateScript)
+ {
+ String quotedRegex = Pattern.quote(updateScript);
+ Pattern pat = Pattern.compile(quotedRegex, Pattern.DOTALL);
+ Matcher mat = pat.matcher(document);
+
+ int count = 0;
+ while (mat.find())
+ {
+ ++count;
+ }
+ // make sure there is only one match
+ assertEquals("There should be 1 and only 1 script in the markup
for this behavior,"
+ + "but " + count + " were found", 1, count);
+ }
+
+ static class MyAjaxSelfUpdatingTimerBehavior extends
AjaxSelfUpdatingTimerBehavior
+ {
+
+ /**
+ *
+ */
+ private static final long serialVersionUID = 1L;
+ private Duration duration;
+ String updateScript;
+
+ /**
+ * Construct.
+ *
+ * @param updateInterval
+ */
+ public MyAjaxSelfUpdatingTimerBehavior(Duration updateInterval)
+ {
+ super(updateInterval);
+ this.duration = updateInterval;
+ }
+
+ @Override
+ protected void onComponentRendered()
+ {
+ super.onComponentRendered();
+ updateScript = getJsTimeoutCall(duration);
+ }
+
+ /**
+ * @return update script
+ */
+ public String getUpdateScript()
+ {
+ return updateScript;
+ }
+
+
+ }
+}
