Top Description Fields Constructors Methods
javax.faces.component.search

public final Enum SearchExpressionHint

extends Enum<SearchExpressionHint>
Class Inheritance
Imports
javax.faces.component.UIComponent

An enum that specifies hints that impact the behavior of a component tree search.

Since
2.3

Field Summary

Modifier and TypeField and Description
public static final SearchExpressionHint
IGNORE_NO_RESULT

Hint that indicates that if a expression resolves to null, null will be returned.

public static final SearchExpressionHint
RESOLVE_CLIENT_SIDE

Hint that indicates that a keyword can be resolved later and will just be returned as passthrough, if supported by the keyword.

public static final SearchExpressionHint
RESOLVE_SINGLE_COMPONENT

Hint that indicates that only one component should be resolved.

public static final SearchExpressionHint
SKIP_VIRTUAL_COMPONENTS

Hint that indicates that only real UIComponents should be resolved.

Constructor Summary

AccessConstructor and Description
private
SearchExpressionHint()

Method Summary

Modifier and TypeMethod and Description
public static SearchExpressionHint
valueOf(String name)

public static SearchExpressionHint[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

IGNORE_NO_RESULTback to summary
public static final SearchExpressionHint IGNORE_NO_RESULT

Hint that indicates that if a expression resolves to null, null will be returned. Otherwise a ComponentNotFoundException will be thrown.

Since
2.3
RESOLVE_CLIENT_SIDEback to summary
public static final SearchExpressionHint RESOLVE_CLIENT_SIDE

Hint that indicates that a keyword can be resolved later and will just be returned as passthrough, if supported by the keyword. For example: The AJAX client- and server-side is able to handle @all or @form. So it's not necessary at all to resolve them to their clientId's on the server side.

Since
2.3
See Also
SearchKeywordResolver#isPassthrough(javax.faces.component.search.SearchExpressionContext, java.lang.String)
RESOLVE_SINGLE_COMPONENTback to summary
public static final SearchExpressionHint RESOLVE_SINGLE_COMPONENT

Hint that indicates that only one component should be resolved. This hint is important if a SearchKeywordResolver uses UIComponent#visitTree, as the tree visit can be terminated after the first component was resolved. This hint will be automatically added internally if SearchExpressionHandler#resolveClientId(javax.faces.component.search.SearchExpressionContext, java.lang.String) or SearchExpressionHandler#resolveComponent(javax.faces.component.search.SearchExpressionContext, java.lang.String, javax.faces.component.ContextCallback) is used.

Since
2.3
SKIP_VIRTUAL_COMPONENTSback to summary
public static final SearchExpressionHint SKIP_VIRTUAL_COMPONENTS

Hint that indicates that only real UIComponents should be resolved. Virtual components are components, which are reused in repeatable components like javax.faces.component.UIData or ui:repeat.

Since
2.3

Constructor Detail

SearchExpressionHintback to summary
private SearchExpressionHint()

Method Detail

valueOfback to summary
public static SearchExpressionHint valueOf(String name)
valuesback to summary
public static SearchExpressionHint[] values()