org.icefaces.ace.util

Class ComponentUtils

java.lang.Object

org.icefaces.ace.util.ComponentUtils

public class ComponentUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ComponentUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	enableOnElementUpdateNotify(javax.faces.context.ResponseWriter writer, java.lang.String id)
static java.lang.String	encodeNameSpace(javax.faces.context.FacesContext fc, java.lang.String id) Environments like portlets need to namespace the components in order to uniquely identify them on the page in case there are multiple instances of the same portlet or different portlets that use the same ids.
static java.lang.String	findClientIds(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String list)
static javax.faces.component.UIComponent	findComponent(javax.faces.component.UIComponent base, java.lang.String id)
static java.util.List<java.lang.String>	findIdsInView(javax.faces.context.FacesContext context) used by GrowlMessagesRenderer and MessagesRenderer for option @inView
static java.util.List<java.lang.String>	findInFacesContext(ButtonGroupMember button, javax.faces.context.FacesContext fc) This method will look in Context attributes for the buttonGroups registered in the view
static java.lang.String	findInHeirarchy(ButtonGroupMember button, javax.faces.context.FacesContext context) A buttonGroup will put itself in the context while its children are rendering and automatically the groupId will set itself.
static javax.faces.component.UIComponent	findParentForm(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
static java.util.ResourceBundle	getComponentResourceBundle(javax.faces.context.FacesContext context, java.lang.String ACE_MESSAGES_BUNDLE) Not all text for components are easy to make attributes for components, especially those for accessibility.
static java.lang.String	getFocusedElementId(javax.faces.component.UIComponent component)
static java.lang.String	getLocalisedMessageFromBundle(java.util.ResourceBundle bundle, java.lang.String MESSAGE_KEY_PREFIX, java.lang.String key, java.lang.String defaultValue)
static java.util.Iterator<javax.faces.application.FacesMessage>	getMessagesInView(javax.faces.context.FacesContext context, java.util.List<java.lang.String> idsInView) used by GrowlMessagesRenderer and MessagesRenderer for option @inView
static java.lang.String	getStringValueToRender(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) 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 - If the component is not a value holder, toString of component is used to support Facelets UIInstructions.
static void	renderPassThroughAttribute(javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, java.lang.String attribute) Render pass-through attribute for the given component.
static void	renderPassThroughAttribute(javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, java.lang.String attribute, java.lang.String initialValue) Render pass-through attribute for the given component.
static void	renderPassThroughAttributes(javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, java.lang.String[] attrs) Render pass-through attributes for the given component.
static java.lang.String	resolveField(javax.el.ValueExpression expression) Attempts to return the property accessed in a simple EL expression of the form ${someObject.property}.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentUtils

public ComponentUtils()

Method Detail

getStringValueToRender

public static java.lang.String getStringValueToRender(javax.faces.context.FacesContext facesContext,
                                      javax.faces.component.UIComponent component)

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

- If the component is not a value holder, toString of component is used to support Facelets UIInstructions.

Parameters:

facesContext - FacesContext instance

component - UIComponent instance whose value will be returned

Returns:

End text

resolveField

public static java.lang.String resolveField(javax.el.ValueExpression expression)

Attempts to return the property accessed in a simple EL expression of the form ${someObject.property}.

Parameters:

expression - An EL expression to parse the property from.

Returns:

The property name of the EL expression.

findParentForm

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

findClientIds

public static java.lang.String findClientIds(javax.faces.context.FacesContext context,
                             javax.faces.component.UIComponent component,
                             java.lang.String list)

encodeNameSpace

public static java.lang.String encodeNameSpace(javax.faces.context.FacesContext fc,
                               java.lang.String id)

Environments like portlets need to namespace the components in order to uniquely identify them on the page in case there are multiple instances of the same portlet or different portlets that use the same ids. This method will prepend the namespace properly taking care to ensure that the namespace is not added twice and that a colon (:) is added if necessary.

Parameters:

fc - The current FacesContext instance

id - The id to encode

Returns:

The namespace encoded id

findComponent

public static javax.faces.component.UIComponent findComponent(javax.faces.component.UIComponent base,
                                              java.lang.String id)

enableOnElementUpdateNotify

public static void enableOnElementUpdateNotify(javax.faces.context.ResponseWriter writer,
                               java.lang.String id)
                                        throws java.io.IOException

Throws:

java.io.IOException

findIdsInView

public static java.util.List<java.lang.String> findIdsInView(javax.faces.context.FacesContext context)

used by GrowlMessagesRenderer and MessagesRenderer for option @inView

Parameters:

context -

Returns:

list of ids in view

getMessagesInView

public static java.util.Iterator<javax.faces.application.FacesMessage> getMessagesInView(javax.faces.context.FacesContext context,
                                                                         java.util.List<java.lang.String> idsInView)

used by GrowlMessagesRenderer and MessagesRenderer for option @inView

Parameters:

context -

idsInView -

Returns:

messages in view iterator

getFocusedElementId

public static java.lang.String getFocusedElementId(javax.faces.component.UIComponent component)

findInHeirarchy

public static java.lang.String findInHeirarchy(ButtonGroupMember button,
                               javax.faces.context.FacesContext context)

A buttonGroup will put itself in the context while its children are rendering and automatically the groupId will set itself. Any radioButton/checkboxButton that is a descendant of a buttonGroup component inherits it as a groupId.

Parameters:

button -

context -

Returns:

the buttonGroup id

findInFacesContext

public static java.util.List<java.lang.String> findInFacesContext(ButtonGroupMember button,
                                                  javax.faces.context.FacesContext fc)

This method will look in Context attributes for the buttonGroups registered in the view

Parameters:

button -

fc -

Returns:

the groupList

renderPassThroughAttributes

public static void renderPassThroughAttributes(javax.faces.context.ResponseWriter writer,
                               javax.faces.component.UIComponent component,
                               java.lang.String[] attrs)
                                        throws java.io.IOException

Render pass-through attributes for the given component.

Parameters:

writer -

component -

attrs -

Throws:

java.io.IOException

renderPassThroughAttribute

public static void renderPassThroughAttribute(javax.faces.context.ResponseWriter writer,
                              javax.faces.component.UIComponent component,
                              java.lang.String attribute,
                              java.lang.String initialValue)
                                       throws java.io.IOException

Render pass-through attribute for the given component.

Parameters:

writer -

component -

attribute -

initialValue -

Throws:

java.io.IOException

renderPassThroughAttribute

public static void renderPassThroughAttribute(javax.faces.context.ResponseWriter writer,
                              javax.faces.component.UIComponent component,
                              java.lang.String attribute)
                                       throws java.io.IOException

Render pass-through attribute for the given component.

Parameters:

writer -

component -

attribute -

Throws:

java.io.IOException

getComponentResourceBundle

public static java.util.ResourceBundle getComponentResourceBundle(javax.faces.context.FacesContext context,
                                                  java.lang.String ACE_MESSAGES_BUNDLE)

Not all text for components are easy to make attributes for components, especially those for accessibility. Default values are made available within the ace jar messages properties files. Users may override the key if they prefer their own, or their locale is not available.

Returns:

reference to resource bundle to get localised text for rendering

getLocalisedMessageFromBundle

public static java.lang.String getLocalisedMessageFromBundle(java.util.ResourceBundle bundle,
                                             java.lang.String MESSAGE_KEY_PREFIX,
                                             java.lang.String key,
                                             java.lang.String defaultValue)

Parameters:

bundle -

MESSAGE_KEY_PREFIX -

key -

defaultValue -

Returns:

localized or internationalized String value from message bundle