git commit: WICKET-4308 onNewBrowserWindow wanted

[mg...@apache.org]

Updated Branches:
  refs/heads/wicket-1.5.x fcf001a21 -> 5b31e98cf


WICKET-4308 onNewBrowserWindow wanted

Downport the new behavior from 6.x


Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/5b31e98c
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/5b31e98c
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/5b31e98c

Branch: refs/heads/wicket-1.5.x
Commit: 5b31e98cfee7ed6af2ce2a79b484446f0324aca7
Parents: fcf001a
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Mon May 28 13:21:32 2012 +0300
Committer: Martin Tzvetanov Grigorov <mg...@apache.org>
Committed: Mon May 28 13:21:32 2012 +0300

----------------------------------------------------------------------
 .../ajax/AjaxNewWindowNotifyingBehavior.java       |  124 +++++++++++++++
 1 files changed, 124 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/5b31e98c/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
new file mode 100644
index 0000000..5337234
--- /dev/null
+++ b/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxNewWindowNotifyingBehavior.java
@@ -0,0 +1,124 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.wicket.ajax;
+
+import java.util.UUID;
+
+import org.apache.wicket.Component;
+import org.apache.wicket.WicketRuntimeException;
+import org.apache.wicket.markup.html.IHeaderResponse;
+import org.apache.wicket.markup.html.WebPage;
+import org.apache.wicket.util.string.JavaScriptUtils;
+import org.apache.wicket.util.string.StringValue;
+
+/**
+ * An Ajax behavior that notifies when a new browser window/tab is opened with
+ * url to a page instance which is already opened in another window/tab in the same user session.
+ *
+ * Note: this behavior may be assigned only to an instance of a WebPage class.
+ *
+ * @since 1.5.7
+ */
+public abstract class AjaxNewWindowNotifyingBehavior extends AbstractDefaultAjaxBehavior
+{
+	/**
+	 * A unique name used for the page window's name
+	 */
+	private final String windowName;
+
+	/**
+	 * The name of the HTTP request parameter that brings the current page window's name.
+	 */
+	private static final String PARAM_WINDOW_NAME = "windowName";
+
+	/**
+	 * A flag whether this behavior has been rendered at least once.
+	 */
+	private boolean hasBeenRendered;
+
+	/**
+	 * Constructor.
+	 */
+	public AjaxNewWindowNotifyingBehavior()
+	{
+		this(UUID.randomUUID().toString());
+	}
+
+	/**
+	 * Constructor.
+	 *
+	 * @param windowName
+	 *      the custom name to use for the page's window
+	 */
+	public AjaxNewWindowNotifyingBehavior(final String windowName)
+	{
+		this.windowName = windowName;
+	}
+
+	@Override
+	protected final void onBind()
+	{
+		super.onBind();
+
+		Component component = getComponent();
+		if (component instanceof WebPage == false)
+		{
+			throw new WicketRuntimeException(AjaxNewWindowNotifyingBehavior.class.getName() + " can be assigned only to WebPage instances.");
+		}
+	}
+
+	@Override
+	public CharSequence getCallbackUrl()
+	{
+		return super.getCallbackUrl() + "&"+PARAM_WINDOW_NAME + "=' + window.name + '";
+	}
+
+	@Override
+	public void renderHead(Component component, IHeaderResponse response)
+	{
+		super.renderHead(component, response);
+
+		if (hasBeenRendered == false)
+		{
+			hasBeenRendered = true;
+			response.renderOnDomReadyJavaScript(String.format("window.name='%s'", windowName));
+		}
+		CharSequence callbackScript = JavaScriptUtils.escapeQuotes(getCallbackScript());
+		response.renderOnLoadJavaScript("setTimeout('" + callbackScript + "', 30);");
+	}
+
+	@Override
+	protected void respond(AjaxRequestTarget target)
+	{
+		StringValue uuidParam = getComponent().getRequest().getRequestParameters().getParameterValue(PARAM_WINDOW_NAME);
+
+		if (windowName.equals(uuidParam.toString()) == false)
+		{
+			onNewWindow(target);
+		}
+	}
+
+	/**
+	 * A callback method when a new window/tab is opened for a page instance
+	 * which is already opened in another window/tab.
+	 *
+	 * @param target
+	 *      the current ajax request handler
+	 */
+	protected abstract void onNewWindow(AjaxRequestTarget target);
+
+}