JsfComponentUtil (josef 3.2.5 API)

java.lang.Object
- org.josef.web.jsf.util.JsfComponentUtil

```
public final class JsfComponentUtil
extends Object
```
Java Server Faces Component Utility class.
This class contains utility methods that are directly applicable to JSF UI components.

Version:

1.0 $Revision: 5773 $

Author:

Kees Schotanus

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Object`	`getAttribute(javax.faces.component.UIComponent uiComponent, String name)` Convenience method to get an attribute from a component.
`static <T> T`	`getAttribute(javax.faces.component.UIComponent uiComponent, String name, T defaultValue)` Convenience method to get an optional attribute of type <T> from a component.
`static boolean`	`getBooleanAttribute(javax.faces.component.UIComponent uiComponent, String name)` Convenience method to get a boolean attribute from a component.
`static String`	`getStringAttribute(javax.faces.component.UIComponent uiComponent, String name)` Convenience method to get a String attribute from a component.
`static <T extends javax.faces.validator.Validator> T`	`getValidator(javax.faces.component.UIInput component, Class<T> type)` Gets the validator from the supplied input component that is of the supplied type T.
`static boolean`	`hasConverter(javax.faces.component.UIComponent component)` Determines whether the supplied component has an attached converter.
`static boolean`	`isComponentsContainerReadonly(javax.faces.component.UIComponent component)` Determines whether the container that contains the supplied component is readonly or not.
`static boolean`	`isComponentsFormReadonly(javax.faces.component.UIComponent component)` Determines whether the form that contains the supplied component is readonly or not.
`static <T extends javax.faces.validator.Validator> int`	`removeValidators(javax.faces.component.UIInput component, Class<T> type)` Removes all validators from the supplied input component that are of the supplied type T.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isComponentsContainerReadonly
```
public static boolean isComponentsContainerReadonly(javax.faces.component.UIComponent component)
```
    Determines whether the container that contains the supplied component is readonly or not.
    A container is readonly when its "readonly" attribute has been set to true or when the container of the container has its "readonly" attribute set to true.
    
    Parameters:
    
    component - The component to check whether it is contained in a readonly container.
    
    Returns:
    
    True when the component is contained in a readonly container, otherwise false.
    
    Throws:
    
    NullPointerException - When the supplied component is null.
  - isComponentsFormReadonly
```
public static boolean isComponentsFormReadonly(javax.faces.component.UIComponent component)
```
    Determines whether the form that contains the supplied component is readonly or not.
    The form is readonly when its "readonly" attribute has been set to true.
    
    Parameters:
    
    component - The component on the form, to check for being readonly.
    
    Returns:
    
    True when the component's form is readonly, otherwise false.
  - getAttribute
```
public static Object getAttribute(javax.faces.component.UIComponent uiComponent,
                                  String name)
```
    Convenience method to get an attribute from a component.
    For example:
```
 <h:commandLink value="Submit" actionListener="#{demoBean.action}">
   <f:attribute name="attributeName" value="attributeValue"/>
 </h:commandLink>
 
```
    In your bean you can use the following code snippet to access the attribute:
```
 public void action(final ActionEvent actionEvent) {
     final Object attributeValue = JsfComponentUtil.getAttribute(
         actionEvent.getComponent(), "attributeName");
 }
 
```
    }
    Parameters:
    
    uiComponent - The UIComponent containing the attribute.
    
    name - The name of the attribute.
    
    Returns:
    
    The value of the attribute with the supplied name or null when no attribute with the supplied name exists.
    
    Throws:
    
    NullPointerException - When either the supplied uiComponent or name is null.
    
    IllegalArgumentException - When the supplied name is empty.
  - getBooleanAttribute
```
public static boolean getBooleanAttribute(javax.faces.component.UIComponent uiComponent,
                                          String name)
```
    Convenience method to get a boolean attribute from a component.
    
    Parameters:
    
    uiComponent - The UIComponent containing the boolean attribute.
    
    name - The name of the attribute.
    
    Returns:
    
    The value of the attribute with the supplied name or false when the attribute with the supplied name does not exist.
    Note: when the attribute is of type String, Boolean.parseBoolean(String) is used for parsing.
    
    Throws:
    
    NullPointerException - When either the supplied uiComponent or name is null.
    
    IllegalArgumentException - When the supplied name is empty or when the attribute is neither a String nor a Boolean.
  - getStringAttribute
```
public static String getStringAttribute(javax.faces.component.UIComponent uiComponent,
                                        String name)
```
    Convenience method to get a String attribute from a component.
    For example:
```
 <h:commandLink value="Submit" actionListener="#{demoBean.action}">
   <f:attribute name="attributeName" value="attributeValue"/>
 </h:commandLink>
 
```
    In your bean you can use the following code snippet to access the attribute:
```
 public void action(final ActionEvent actionEvent) {
     final String attributeValue = JsfComponentUtil.getStringAttribute(
         actionEvent.getComponent(), "attributeName");
 }
```
    Parameters:
    
    uiComponent - The UIComponent containing the attribute.
    
    name - The name of the attribute.
    
    Returns:
    
    The value of the attribute with the supplied name or null when no attribute with the supplied name exists.
    
    Throws:
    
    NullPointerException - When either the supplied uiComponent or name is null.
    
    IllegalArgumentException - When the supplied name is empty.
  - getAttribute
```
public static <T> T getAttribute(javax.faces.component.UIComponent uiComponent,
                                 String name,
                                 T defaultValue)
```
    Convenience method to get an optional attribute of type <T> from a component.
    For example:
```
 <ice:selectInputText id="idScientistName" rows="5"
   valueChangeListener="#{managedBean.updateAutoCompleteListener}" .../>
 
```
    In your bean you can use code like the following to access the attribute:
```
 public void updateAutoCompleteListener(final ValueChangeEvent valueChangeEvent) {
     final Integer rows = getAttribute(valueChangeEvent.getComponent(),
         "rows", Integer.valueOf(5));
     ...
 }
```
    Type Parameters:
    
    T - The type of the attribute to return.
    
    Parameters:
    
    uiComponent - The UIComponent containing the attribute.
    
    name - The name of the attribute.
    
    defaultValue - The value to return when the attribute with the supplied name does not exist.
    
    Returns:
    
    The value of the attribute with the supplied name or the supplied defaultValue when no attribute with the supplied name exists.
    
    Throws:
    
    ClassCastException - When the attribute with the supplied name is not of type <T>
    
    NullPointerException - When either the supplied uiComponent or name is null.
    
    IllegalArgumentException - When the supplied name is empty.
  - hasConverter
```
public static boolean hasConverter(javax.faces.component.UIComponent component)
```
    Determines whether the supplied component has an attached converter.
    
    Parameters:
    
    component - The component to check for a converter.
    
    Returns:
    
    True when the supplied component has an attached converter, otherwise false is returned.
  - getValidator
```
public static <T extends javax.faces.validator.Validator> T getValidator(javax.faces.component.UIInput component,
                                                                         Class<T> type)
```
    Gets the validator from the supplied input component that is of the supplied type T.
    When more validators of the supplied type exist, the first found is returned.
    
    Type Parameters:
    
    T - The type of the validator to get.
    
    Parameters:
    
    component - The component to get the validator from.
    
    type - The type of validator to get.
    
    Returns:
    
    The validator or null when the supplied component does not have a validator of the supplied type.
    
    Throws:
    
    NullPointerException - When either the supplied component or type is null.
  - removeValidators
```
public static <T extends javax.faces.validator.Validator> int removeValidators(javax.faces.component.UIInput component,
                                                                               Class<T> type)
```
    Removes all validators from the supplied input component that are of the supplied type T.
    
    Type Parameters:
    
    T - The type of validator to remove.
    
    Parameters:
    
    component - The component to remove the validators from.
    
    type - The type of validator to remove.
    
    Returns:
    
    The number of validators that have been removed.
    
    Throws:
    
    NullPointerException - When either the supplied component or type is null.

Class JsfComponentUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isComponentsContainerReadonly

isComponentsFormReadonly

getAttribute

getBooleanAttribute

getStringAttribute

getAttribute

hasConverter

getValidator

removeValidators