Module org.omnifaces

Package org.omnifaces.cdi.viewscope

Class ViewScopeUnloadScriptRenderer

java.lang.Object

jakarta.faces.render.Renderer<UIOutput>

org.omnifaces.renderer.InlineResourceRenderer

org.omnifaces.renderer.InlineScriptRenderer

org.omnifaces.cdi.viewscope.ViewScopeUnloadScriptRenderer

public class ViewScopeUnloadScriptRenderer
extends InlineScriptRenderer

This renderer renders the value of the given UIOutput as the inline script which initializes the unload of the OmniFaces ViewScoped beans of the current view. Right before that, it puts the pending bean storage of the current view in the active view scopes, see ViewScopeStorageInSession, because the client is then about to receive the unload script which can destroy them. A failure later in the same response leaves them active until they are evicted from the active view scopes or the HTTP session expires. This is internally only used by ViewScopeManager.

Since:

3.14.28

Author:

Bauke Scholtz

See Also:

• ViewScopeManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RENDERER_TYPE	The standard renderer type.

Fields inherited from class jakarta.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor	Description
ViewScopeUnloadScriptRenderer()

Method Summary

Modifier and Type	Method	Description
void	encodeChildren(FacesContext context, UIOutput component)	Activate the pending view scope of the current view and then write the value of the given UIOutput as inline script.

Methods inherited from class org.omnifaces.renderer.InlineScriptRenderer

endElement, startElement, writeResource

Methods inherited from class org.omnifaces.renderer.InlineResourceRenderer

getRendersChildren

Methods inherited from class jakarta.faces.render.Renderer

convertClientId, decode, encodeBegin, encodeEnd, getConvertedValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RENDERER_TYPE

public static final String RENDERER_TYPE

The standard renderer type.

See Also:

• Constant Field Values

Constructor Details

ViewScopeUnloadScriptRenderer

public ViewScopeUnloadScriptRenderer()

Method Details

encodeChildren

public void encodeChildren(FacesContext context,
 UIOutput component)
                    throws IOException

Activate the pending view scope of the current view and then write the value of the given UIOutput as inline script.

Overrides:

encodeChildren in class InlineResourceRenderer

Throws:

IOException