Module org.omnifaces

Package org.omnifaces.component.output

Class ConditionalComment

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

org.omnifaces.component.output.OutputFamily

org.omnifaces.component.output.ConditionalComment

All Implemented Interfaces:

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

public class ConditionalComment
extends OutputFamily

The <o:conditionalComment> component renders a conditional comment. Conditional comments are an IE specific feature which enables the developer to (out)comment blocks of HTML depending on whether the client is using IE and if so even which version. They are often seen in combination with CSS stylesheets like so:

 <!--[if lte IE 7]>
     <link rel="stylesheet" href="ie6-ie7.css" />
 <![endif]-->
 

However, Facelets renders the comment's contents HTML-escaped which makes it unusable.

 <!--[if lte IE 7]&gt;
     &lt;link rel=&quot;stylesheet&quot; href=&quot;ie6-ie7.css&quot; /&gt;
 &lt;![endif]-->
 

Also, if jakarta.faces.FACELETS_SKIP_COMMENTS context param is set to true then it will even not be rendered at all. You would need to workaround this with an ugly <h:outputText escape="false">.

 <h:outputText
     value="&lt;!--[if lte IE 7]&gt;&lt;link rel=&quot;stylesheet&quot; href=&quot;ie6-ie7.css&quot; /&gt;&lt;![endif]--&gt;"
     escape="false" />
 

This component is designed to solve this problem.

 <o:conditionalComment if="lte IE 7">
     <link rel="stylesheet" href="ie6-ie7.css" />
 </o:conditionalComment>
 

Note that you cannot use this with <h:outputStylesheet> as it would implicitly be relocated as direct child of <h:head>.

Author:

Bauke Scholtz

See Also:

• OutputFamily

Field Summary

Fields

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

Fields inherited from class org.omnifaces.component.output.OutputFamily

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
ConditionalComment()

Method Summary

Modifier and Type	Method	Description
void	encodeBegin(FacesContext context)
void	encodeEnd(FacesContext context)
String	getIf()	Returns the if condition.
void	setIf(String condition)	Sets the if condition.

Methods inherited from class org.omnifaces.component.output.OutputFamily

getFamily, getRendersChildren

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeChildren, 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, processEvent, 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.output.ConditionalComment".

See Also:

• Constant Field Values

Constructor Details

ConditionalComment

public ConditionalComment()

Method Details

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IllegalArgumentException - When if attribute is not specified.

IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

getIf

public String getIf()

Returns the if condition.

Returns:

The if condition.

setIf

public void setIf(String condition)

Sets the if condition.

Parameters:

condition - The if condition.