/*

   * 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.behavior;

 import org.apache.wicket.Component;

 import org.apache.wicket.RequestListenerInterface;

 import org.apache.wicket.Response;

 import org.apache.wicket.markup.ComponentTag;

 import org.apache.wicket.markup.html.IHeaderContributor;

 import org.apache.wicket.markup.html.IHeaderResponse;

 public abstract class AbstractAjaxBehavior extends AbstractBehavior

 	implements

 		IBehaviorListener,

 		IHeaderContributor

 {
	

 	private static final long serialVersionUID = 1L;
	

 	private Component component;

	

 	public AbstractAjaxBehavior()

 	{

 	}

	

 	public final void bind(final Component hostComponent)

 	{

 		if (hostComponent == null)

 		{

 			throw new IllegalArgumentException("Argument hostComponent must be not null");

 		}

 		if (component != null)

 		{

 			throw new IllegalStateException("this kind of handler cannot be attached to " +

 				"multiple components; it is already attached to component " + component +

 				", but component " + hostComponent + " wants to be attached too");

 		}

 		component = hostComponent;

 		// call the callback

 		onBind();

 	}

	

 	/*

 	 * TODO 1.4 remove this and only keep the (boolean) variant. its a huge mess to have both

 	 * because both need to be overridable and you never know which one an intermediary subclass

 	 * overrides to add its behavior, or all subclasses must be made to override both :|

 	 */

 	public CharSequence getCallbackUrl()

 	{

 		return getCallbackUrl(true);

 	}

	

	public CharSequence getCallbackUrl(final boolean onlyTargetActivePage)

	{

		if (getComponent() == null)

		{

			throw new IllegalArgumentException(

				"Behavior must be bound to a component to create the URL");

		}

		final RequestListenerInterface rli;

		if (onlyTargetActivePage)

		{

			rli = IActivePageBehaviorListener.INTERFACE;

		}

		else

		{

			rli = IBehaviorListener.INTERFACE;

		}

		return getComponent().urlFor(this, rli);

	}

	

	public final void onComponentTag(final Component component, final ComponentTag tag)

	{

		onComponentTag(tag);

	}

	

	public final void onRendered(final Component hostComponent)

	{

		onComponentRendered();

	}

	

	public void renderHead(final IHeaderResponse response)

	{

	}

	

	protected final Component getComponent()

	{

		return component;

	}

	

	protected void onComponentTag(final ComponentTag tag)

	{

	}

	

	protected void onBind()

	{

	}

	

	protected void onComponentRendered()

	{

	}

	

	public boolean getStatelessHint(Component component)

	{

		return false;

	}

	// TODO the next three methods will be removed with next commit. Here as

	// final to help with refactoring

	protected final String getImplementationId()

	{

		return "foo";

	}

	protected final void onRenderHeadContribution(final Response response)

	{

	}

	protected final void onRenderHeadInitContribution(final Response response)

	{

	}

}