org.wicketstuff.chat.channel.api.IChannelTarget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicket-chat-api Show documentation

This project holds interfaces for the chat communication. Inspired from the wicketstuff push project. Many interfaces are took from the wicketstuff push project.

The newest version!

/**
 * Copyright (C) 2015 Asterios Raptis
 *
 * 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 org.wicketstuff.chat.channel.api;

import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;

/**
 * Defines an interface to trigger client updates on server side events.
 * 
 * This interface is very similar to the API of the {@link AjaxRequestTarget}, so users already
 * familiar with {@link AjaxRequestTarget} should easily find their way with this interface.
 * 
 * 
 * A {@link IChannelTarget} implementation can be used in {@link IChannelListener} implementations.
 * 
 * 
 * @author Xavier Hanin
 * 
 */
public interface IChannelTarget
{
	/**
	 * Adds a component to the list of components to be rendered
	 * 
	 * @param component
	 *            component to be rendered
	 */
	public void addComponent(final Component component);

	/**
	 * Adds a component to the list of components to be rendered
	 * 
	 * @param markupId
	 *            id of client-side dom element that will be updated
	 * 
	 * @param component
	 *            component to be rendered
	 */
	public void addComponent(final Component component, final String markupId);

	/**
	 * Adds javascript that will be evaluated on the client side after components are replaced
	 * 
	 * @param javascript
	 *            The js to append
	 */
	public void appendJavaScript(final String javascript);

	/**
	 * Sets the focus in the browser to the given component. The markup id must be set.
	 * 
	 * @param component
	 *            The component to get the focus.
	 */
	public void focusComponent(final Component component);

	/**
	 * Adds javascript that will be evaluated on the client side before components are replaced
	 * 
	 * @param javascript
	 *            The js to prepend
	 */
	public void prependJavaScript(final String javascript);
}