org.wicketstuff.chat.channel.api

Interface IChannelTarget

All Known Subinterfaces:

IPushTarget

public interface IChannelTarget

Defines an interface to trigger client updates on server side events.

This interface is very similar to the API of the AjaxRequestTarget, so users already familiar with AjaxRequestTarget should easily find their way with this interface.

A IChannelTarget implementation can be used in IChannelListener implementations.

Author:

Xavier Hanin

Method Summary

Modifier and Type	Method and Description
void	addComponent(org.apache.wicket.Component component) Adds a component to the list of components to be rendered
void	addComponent(org.apache.wicket.Component component, String markupId) Adds a component to the list of components to be rendered
void	appendJavaScript(String javascript) Adds javascript that will be evaluated on the client side after components are replaced
void	focusComponent(org.apache.wicket.Component component) Sets the focus in the browser to the given component.
void	prependJavaScript(String javascript) Adds javascript that will be evaluated on the client side before components are replaced

Method Detail

addComponent

void addComponent(org.apache.wicket.Component component)

Adds a component to the list of components to be rendered

Parameters:

component - component to be rendered

addComponent

void addComponent(org.apache.wicket.Component component,
                  String markupId)

Adds a component to the list of components to be rendered

Parameters:

markupId - id of client-side dom element that will be updated

component - component to be rendered

focusComponent

void focusComponent(org.apache.wicket.Component component)

Sets the focus in the browser to the given component. The markup id must be set.

Parameters:

component - The component to get the focus.

appendJavaScript

void appendJavaScript(String javascript)

Adds javascript that will be evaluated on the client side after components are replaced

Parameters:

javascript - The js to append

prependJavaScript

void prependJavaScript(String javascript)

Adds javascript that will be evaluated on the client side before components are replaced

Parameters:

javascript - The js to prepend