Module org.omnifaces

Package org.omnifaces.component.stylesheet

Class CriticalStylesheet

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

org.omnifaces.component.stylesheet.StylesheetFamily

org.omnifaces.component.stylesheet.CriticalStylesheet

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

public class CriticalStylesheet
extends StylesheetFamily

The <o:criticalStylesheet> is a component based on the standard <h:outputStylesheet> which renders a <link rel="preload" as="style"> instead of <link rel="stylesheet"> and automatically changes the rel="preload" to rel="stylesheet" during window load event. Additionally, it will automatically be moved to the very top of the head.

Usage

Just use it the same way as a <h:outputStylesheet>, with a library and name.

 <o:criticalStylesheet library="yourlibrary" name="scripts/filename.js" />
 

You can even explicitly configure third-party stylesheet resources to be loaded this way, such as PrimeFaces stylesheets.

 <o:criticalStylesheet library="primefaces" name="components.css" />
 <o:criticalStylesheet library="primefaces" name="layout.css" />
 

Since:

4.5

Author:

Bauke Scholtz

See Also:

• StylesheetFamily
• CriticalStylesheetRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_TYPE	The component type, which is "org.omnifaces.component.stylesheet.CriticalStylesheet".

Fields inherited from class org.omnifaces.component.stylesheet.StylesheetFamily

COMPONENT_FAMILY

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
CriticalStylesheet()	Construct a new CriticalStylesheet component whereby the renderer type is set to CriticalStylesheetRenderer.RENDERER_TYPE.

Method Summary

Modifier and Type	Method	Description
String	getLibrary()	Returns the "library name" part of the resource identifier.
String	getMedia()	Returns the media that the stylesheet applies to.
String	getName()	Returns the "resource name" part of the resource identifier.
void	processEvent(ComponentSystemEvent event)	Makes sure the critical style sheet gets added to top of head.
void	setLibrary(String library)	Sets the "library name" part of the resource identifier.
void	setMedia(String media)	Sets the media that the stylesheet applies to.
void	setName(String name)	Sets the "resource name" part of the resource identifier.

Methods inherited from class org.omnifaces.component.stylesheet.StylesheetFamily

getFamily, getRendersChildren

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

Methods inherited from class jakarta.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The component type, which is "org.omnifaces.component.stylesheet.CriticalStylesheet".

See Also:

• Constant Field Values

Constructor Details

CriticalStylesheet

public CriticalStylesheet()

Construct a new CriticalStylesheet component whereby the renderer type is set to CriticalStylesheetRenderer.RENDERER_TYPE.

Method Details

processEvent

public void processEvent(ComponentSystemEvent event)
                  throws AbortProcessingException

Makes sure the critical style sheet gets added to top of head.

Specified by:

processEvent in interface ComponentSystemEventListener

Overrides:

processEvent in class UIComponent

Throws:

AbortProcessingException

getLibrary

public String getLibrary()

Returns the "library name" part of the resource identifier.

Returns:

The library name.

setLibrary

public void setLibrary(String library)

Sets the "library name" part of the resource identifier.

Parameters:

library - The library name.

getName

public String getName()

Returns the "resource name" part of the resource identifier.

Returns:

The resource name.

setName

public void setName(String name)

Sets the "resource name" part of the resource identifier.

Parameters:

name - The resource name.

getMedia

public String getMedia()

Returns the media that the stylesheet applies to.

Returns:

The media type.

setMedia

public void setMedia(String media)

Sets the media that the stylesheet applies to.

Parameters:

media - The media type.