org.primefaces.util

Class ComponentUtils

java.lang.Object

org.primefaces.util.ComponentUtils

public class ComponentUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SKIP_ITERATION_HINT
static EnumSet<javax.faces.component.visit.VisitHint>	VISIT_HINTS_SKIP_UNRENDERED

Constructor Summary

Constructors

Constructor and Description
ComponentUtils()

Method Summary

Modifier and Type	Method and Description
static String	calculateViewId(javax.faces.context.FacesContext context) Calculates the current viewId - we can't get it from the ViewRoot if it's not available.
static String	createContentDisposition(String value, String filename) Creates an RFC 6266 Content-Dispostion header following all UTF-8 conventions.
static String	encodeURI(String string) Duplicate code from OmniFacew project under apache license: https://github.com/omnifaces/omnifaces/blob/develop/license.txt
static boolean	equals(Object object1, Object object2)
static String	escapeEcmaScriptText(String text)
static String	escapeSelector(String selector)
static String	escapeText(String text) Duplicate code from json-simple project under apache license http://code.google.com/p/json-simple/source/browse/trunk/src/org/json/simple/JSONValue.java
static String	escapeXml(String string) Replace special characters with XML escapes:
static String	findComponentClientId(String id) Deprecated.
static javax.faces.application.NavigationCase	findNavigationCase(javax.faces.context.FacesContext context, String outcome)
static javax.faces.component.UIComponent	findParentForm(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Deprecated.
static javax.faces.convert.Converter	getConverter(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Finds appropriate converter for a given value holder
static String	getResourceURL(javax.faces.context.FacesContext context, String value)
static Map<String,List<String>>	getUIParams(javax.faces.component.UIComponent component)
static <T extends javax.faces.render.Renderer> T	getUnwrappedRenderer(javax.faces.context.FacesContext context, String family, String rendererType, Class<T> rendererClass)
static String	getValueToRender(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
static String	getValueToRender(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value) Algorithm works as follows; - If it's an input component, submitted value is checked first since it'd be the value to be used in case validation errors terminates jsf lifecycle - Finally the value of the component is retrieved from backing bean and if there's a converter, converted value is returned
static boolean	isRequestSource(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
static boolean	isRTL(javax.faces.context.FacesContext context, RTLAware component)
static boolean	isSkipIteration(javax.faces.component.visit.VisitContext visitContext, javax.faces.context.FacesContext context)
static boolean	isValueBlank(String value)
static void	processDecodesOfFacetsAndChilds(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
static void	processUpdatesOfFacetsAndChilds(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
static void	processValidatorsOfFacetsAndChilds(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
static String	replaceNewLineWithHtml(String text)
static TimeZone	resolveTimeZone(Object timeZone) Gets a TimeZone instance by the parameter "timeZone" which can be String or TimeZone or null.
static String	resolveWidgetVar(javax.faces.context.FacesContext context, Widget widget)
static String	resolveWidgetVar(String expression) Deprecated.
static String	resolveWidgetVar(String expression, javax.faces.component.UIComponent component) Deprecated.
static boolean	shouldRenderFacet(javax.faces.component.UIComponent facet) Checks if the facet and one of the first level child's is rendered.

Methods inherited from class java.lang.Object

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

Field Detail

VISIT_HINTS_SKIP_UNRENDERED

public static final EnumSet<javax.faces.component.visit.VisitHint> VISIT_HINTS_SKIP_UNRENDERED

SKIP_ITERATION_HINT

public static final String SKIP_ITERATION_HINT

See Also:

Constant Field Values

Constructor Detail

ComponentUtils

public ComponentUtils()

Method Detail

getValueToRender

public static String getValueToRender(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component)

getValueToRender

public static String getValueToRender(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component,
                                      Object value)

Algorithm works as follows; - If it's an input component, submitted value is checked first since it'd be the value to be used in case validation errors terminates jsf lifecycle - Finally the value of the component is retrieved from backing bean and if there's a converter, converted value is returned

Parameters:

context - FacesContext instance

component - UIComponent instance whose value will be returned

value - The value of UIComponent if already evaluated outside. E.g. in the renderer.

Returns:

End text

getConverter

public static javax.faces.convert.Converter getConverter(javax.faces.context.FacesContext context,
                                                         javax.faces.component.UIComponent component)

Finds appropriate converter for a given value holder

Parameters:

context - FacesContext instance

component - ValueHolder instance to look converter for

Returns:

Converter

findComponentClientId

@Deprecated
public static String findComponentClientId(String id)

Deprecated.

escapeSelector

public static String escapeSelector(String selector)

resolveWidgetVar

@Deprecated
public static String resolveWidgetVar(String expression)

Deprecated.

resolveWidgetVar

@Deprecated
public static String resolveWidgetVar(String expression,
                                                   javax.faces.component.UIComponent component)

Deprecated.

isValueBlank

public static boolean isValueBlank(String value)

isRTL

public static boolean isRTL(javax.faces.context.FacesContext context,
                            RTLAware component)

processDecodesOfFacetsAndChilds

public static void processDecodesOfFacetsAndChilds(javax.faces.component.UIComponent component,
                                                   javax.faces.context.FacesContext context)

processValidatorsOfFacetsAndChilds

public static void processValidatorsOfFacetsAndChilds(javax.faces.component.UIComponent component,
                                                      javax.faces.context.FacesContext context)

processUpdatesOfFacetsAndChilds

public static void processUpdatesOfFacetsAndChilds(javax.faces.component.UIComponent component,
                                                   javax.faces.context.FacesContext context)

findNavigationCase

public static javax.faces.application.NavigationCase findNavigationCase(javax.faces.context.FacesContext context,
                                                                        String outcome)

getUIParams

public static Map<String,List<String>> getUIParams(javax.faces.component.UIComponent component)

getResourceURL

public static String getResourceURL(javax.faces.context.FacesContext context,
                                    String value)

isSkipIteration

public static boolean isSkipIteration(javax.faces.component.visit.VisitContext visitContext,
                                      javax.faces.context.FacesContext context)

resolveWidgetVar

public static String resolveWidgetVar(javax.faces.context.FacesContext context,
                                      Widget widget)

replaceNewLineWithHtml

public static String replaceNewLineWithHtml(String text)

escapeText

public static String escapeText(String text)

Duplicate code from json-simple project under apache license http://code.google.com/p/json-simple/source/browse/trunk/src/org/json/simple/JSONValue.java

escapeEcmaScriptText

public static String escapeEcmaScriptText(String text)

escapeXml

public static String escapeXml(String string)

Replace special characters with XML escapes:

 & (ampersand) is replaced by &
 < (less than) is replaced by &lt;
 > (greater than) is replaced by &gt;
 " (double quote) is replaced by &quot;
 

Parameters:

string - The string to be escaped.

Returns:

The escaped string.

findParentForm

@Deprecated
public static javax.faces.component.UIComponent findParentForm(javax.faces.context.FacesContext context,
                                                                            javax.faces.component.UIComponent component)

Deprecated.

Use ComponentTraversalUtils.closestForm(javax.faces.context.FacesContext, javax.faces.component.UIComponent) instead.

Parameters:

context -

component -

Returns:

resolveTimeZone

public static TimeZone resolveTimeZone(Object timeZone)

Gets a TimeZone instance by the parameter "timeZone" which can be String or TimeZone or null.

Parameters:

timeZone - given time zone

Returns:

resolved TimeZone

getUnwrappedRenderer

public static <T extends javax.faces.render.Renderer> T getUnwrappedRenderer(javax.faces.context.FacesContext context,
                                                                             String family,
                                                                             String rendererType,
                                                                             Class<T> rendererClass)

calculateViewId

public static String calculateViewId(javax.faces.context.FacesContext context)

Calculates the current viewId - we can't get it from the ViewRoot if it's not available.

Parameters:

context - The FacesContext.

Returns:

The current viewId.

encodeURI

public static String encodeURI(String string)
                        throws UnsupportedEncodingException

Duplicate code from OmniFacew project under apache license: https://github.com/omnifaces/omnifaces/blob/develop/license.txt

URI-encode the given string using UTF-8. URIs (paths and filenames) have different encoding rules as compared to URL query string parameters. URLEncoder is actually only for www (HTML) form based query string parameter values (as used when a webbrowser submits a HTML form). URI encoding has a lot in common with URL encoding, but the space has to be %20 and some chars doesn't necessarily need to be encoded.

Parameters:

string - The string to be URI-encoded using UTF-8.

Returns:

The given string, URI-encoded using UTF-8, or null if null was given.

Throws:

UnsupportedEncodingException - if UTF-8 is not supported

createContentDisposition

public static String createContentDisposition(String value,
                                              String filename)

Creates an RFC 6266 Content-Dispostion header following all UTF-8 conventions.

Parameters:

value - e.g. "attachment"

filename - the name of the file

Returns:

a valid Content-Disposition header in UTF-8 format

isRequestSource

public static boolean isRequestSource(javax.faces.component.UIComponent component,
                                      javax.faces.context.FacesContext context)

shouldRenderFacet

public static boolean shouldRenderFacet(javax.faces.component.UIComponent facet)

Checks if the facet and one of the first level child's is rendered.

Parameters:

facet - The Facet component to check

Returns:

true when facet and one of the first level child's is rendered.

equals

public static boolean equals(Object object1,
                             Object object2)