Module org.omnifaces

Package org.omnifaces.converter

Class SelectItemsIndexConverter

java.lang.Object

org.omnifaces.converter.SelectItemsIndexConverter

All Implemented Interfaces:

Converter<Object>

public class SelectItemsIndexConverter
extends Object
implements Converter<Object>

The omnifaces.SelectItemsIndexConverter is a variant of the SelectItemsConverter which automatically converts based on the position (index) of the selected item in the list instead of the Object.toString() of the selected item.

Usage

This converter is available by converter ID omnifaces.SelectItemsIndexConverter. Just specify it in the converter attribute of the selection component holding <f:selectItems>.

 <h:selectOneMenu value="#{bean.selectedItem}" converter="omnifaces.SelectItemsIndexConverter">
     <f:selectItems value="#{bean.availableItems}" />
 </h:selectOneMenu>
 

Since OmniFaces 4.5 it's also available by <o:selectItemsIndexConverter> tag.

 <h:selectOneMenu value="#{bean.selectedItem}">
     <f:selectItems value="#{bean.availableItems}" />
     <o:selectItemsIndexConverter />
 </h:selectOneMenu>
 

Pros and cons as compared to SelectItemsConverter

This converter has the following advantages over SelectItemsConverter:

• No need to rely on Object.toString() method of the object.
• No need to extend the SelectItemsConverter when Object.toString() method of the object cannot be used.
• No need to expose the object's unique key in its Object.toString(),if that's a problem.

This converter has the following disadvantage over SelectItemsConverter:

• The "Validation Error: value is not valid" will never occur anymore for the case that the available select items has incompatibly changed during the postback due to a developer's mistake. The developer should make absolutely sure that exactly the same list is preserved on postback (e.g. by making it a property of a view scoped or broader scoped bean).

Since:

1.3

Author:

Patrick Dobler, Bauke Scholtz

See Also:

• SelectItemsUtils
• SelectItemsCollector

Field Summary

Fields inherited from interface jakarta.faces.convert.Converter

DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
SelectItemsIndexConverter()

Method Summary

Modifier and Type	Method	Description
Object	getAsObject(FacesContext context, UIComponent component, String submittedValue)
String	getAsString(FacesContext context, UIComponent component, Object modelValue)

Methods inherited from class java.lang.Object

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

Constructor Details

SelectItemsIndexConverter

public SelectItemsIndexConverter()

Method Details

getAsObject

public Object getAsObject(FacesContext context,
 UIComponent component,
 String submittedValue)

Specified by:

getAsObject in interface Converter<Object>

getAsString

public String getAsString(FacesContext context,
 UIComponent component,
 Object modelValue)

Specified by:

getAsString in interface Converter<Object>