public enum SearchExpressionHint extends Enum<SearchExpressionHint>
An enum that specifies hints that impact the behavior of a component tree search.
Enum Constant and Description |
---|
IGNORE_NO_RESULT
Hint that indicates that if a expression resolves to |
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. |
RESOLVE_SINGLE_COMPONENT
Hint that indicates that only one component should be resolved. |
SKIP_VIRTUAL_COMPONENTS
Hint that indicates that only real |
Modifier and Type | Method and Description |
---|---|
static SearchExpressionHint |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static SearchExpressionHint[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
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.
public static final SearchExpressionHint SKIP_VIRTUAL_COMPONENTS
Hint that indicates that only real UIComponent
s should be resolved.
Virtual components are components, which are reused in repeatable components like UIData
or ui:repeat
.
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(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)
,
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.
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.
public static SearchExpressionHint[] values()
for (SearchExpressionHint c : SearchExpressionHint.values()) System.out.println(c);
public static SearchExpressionHint valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2019 Eclipse Foundation.
Use is subject to license terms.