org.omnifaces.resourcehandler

Class CombinedResourceHandler

java.lang.Object

javax.faces.application.ResourceHandler

javax.faces.application.ResourceHandlerWrapper

org.omnifaces.resourcehandler.CombinedResourceHandler

All Implemented Interfaces:

java.util.EventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListener, javax.faces.FacesWrapper<javax.faces.application.ResourceHandler>

public class CombinedResourceHandler
extends javax.faces.application.ResourceHandlerWrapper
implements javax.faces.event.SystemEventListener

This ResourceHandler implementation will remove all separate script and stylesheet resources from the head and create a combined one for all scripts and another combined one for all stylesheets.

This handler must be registered as follows in faces-config.xml:

 <application>
   <resource-handler>org.omnifaces.resourcehandler.CombinedResourceHandler</resource-handler>
 </application>
 

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LIBRARY_NAME The default library name of a combined resource.

Fields inherited from class javax.faces.application.ResourceHandler

LOCALE_PREFIX, RESOURCE_EXCLUDES_DEFAULT_VALUE, RESOURCE_EXCLUDES_PARAM_NAME, RESOURCE_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
CombinedResourceHandler(javax.faces.application.ResourceHandler wrapped) Creates a new instance of this combined resource handler which wraps the given resource handler.

Method Summary

Methods

Modifier and Type	Method and Description
javax.faces.application.Resource	createResource(java.lang.String resourceName, java.lang.String libraryName)
javax.faces.application.ResourceHandler	getWrapped()
void	handleResourceRequest(javax.faces.context.FacesContext context)
boolean	isListenerForSource(java.lang.Object source) Returns true if the source is an instance of UIViewRoot.
void	processEvent(javax.faces.event.SystemEvent event) Before rendering of a freshly created view, perform the following actions: Collect all component resources from the head.

Methods inherited from class javax.faces.application.ResourceHandlerWrapper

createResource, createResource, getRendererTypeForResourceName, isResourceRequest, libraryExists

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_NAME

public static final java.lang.String LIBRARY_NAME

The default library name of a combined resource. Make sure that this is never used for other libraries.

See Also:

Constant Field Values

Constructor Detail

CombinedResourceHandler

public CombinedResourceHandler(javax.faces.application.ResourceHandler wrapped)

Creates a new instance of this combined resource handler which wraps the given resource handler. This will also immediately register this resource handler as a pre render view event listener, so that it can do the job of removing the CSS/JS resources and adding combined ones.

Parameters:

wrapped - The resource handler to be wrapped.

Method Detail

isListenerForSource

public boolean isListenerForSource(java.lang.Object source)

Returns true if the source is an instance of UIViewRoot.

Specified by:

isListenerForSource in interface javax.faces.event.SystemEventListener

processEvent

public void processEvent(javax.faces.event.SystemEvent event)
                  throws javax.faces.event.AbortProcessingException

Before rendering of a freshly created view, perform the following actions:

• Collect all component resources from the head.
• Check and collect the script and stylesheet resources separately and remove them from the head.
• If there are any resources in the collection of script and/or stylesheet resources, then create a component resource component pointing to the combined resource info and add it to the head.

Specified by:

processEvent in interface javax.faces.event.SystemEventListener

Throws:

javax.faces.event.AbortProcessingException

createResource

public javax.faces.application.Resource createResource(java.lang.String resourceName,
                                              java.lang.String libraryName)

Overrides:

createResource in class javax.faces.application.ResourceHandlerWrapper

handleResourceRequest

public void handleResourceRequest(javax.faces.context.FacesContext context)
                           throws java.io.IOException

Overrides:

handleResourceRequest in class javax.faces.application.ResourceHandlerWrapper

Throws:

java.io.IOException

getWrapped

public javax.faces.application.ResourceHandler getWrapped()

Specified by:

getWrapped in interface javax.faces.FacesWrapper<javax.faces.application.ResourceHandler>

Overrides:

getWrapped in class javax.faces.application.ResourceHandlerWrapper