org.icefaces.application

Interface PortableRenderer

public interface PortableRenderer

PortableRenderer can trigger asynchronous rendering outside of a JSF lifecycle.

Method Summary

Modifier and Type	Method and Description
void	addCurrentSession(java.lang.String groupName) All subsequently created views in the current session will be added to the specified group.
void	removeCurrentSession(java.lang.String groupName) Remove the current views from the specified group.
void	render(java.lang.String group) Render the specified group of sessions by performing the JavaServer Faces execute and render lifecycle phases.
void	render(java.lang.String group, org.icefaces.application.PushOptions options) Render message to the specified group of sessions but only to the clients that have their blocking connection paused.

Method Detail

render

void render(java.lang.String group)

Render the specified group of sessions by performing the JavaServer Faces execute and render lifecycle phases. If a FacesContext is in the scope of the current thread scope, the current view will not be asynchronously rendered (it is already rendered as a result of the user event being processed).

Parameters:

group - the group of sessions to be rendered

render

void render(java.lang.String group,
            org.icefaces.application.PushOptions options)

Render message to the specified group of sessions but only to the clients that have their blocking connection paused.

Parameters:

group - the group to render

options - the PushOptions to use during the render

addCurrentSession

void addCurrentSession(java.lang.String groupName)

All subsequently created views in the current session will be added to the specified group. Groups of sessions are automatically garbage collected when all member sessions have become invalid.

Parameters:

groupName - the name of the group to add the current session to

removeCurrentSession

void removeCurrentSession(java.lang.String groupName)

Remove the current views from the specified group. Use of this method is optional as group membership is maintained automatically as clients leave.

Parameters:

groupName - the name of the group to remove the current view from