org.nuxeo.ecm.platform.ui.web.tag.handler

Class SetTagHandler

java.lang.Object

javax.faces.view.facelets.TagHandler

javax.faces.view.facelets.MetaTagHandler

javax.faces.view.facelets.DelegatingMetaTagHandler

javax.faces.view.facelets.ComponentHandler

org.nuxeo.ecm.platform.ui.web.binding.alias.AliasTagHandler

org.nuxeo.ecm.platform.ui.web.tag.handler.SetTagHandler

All Implemented Interfaces:

javax.faces.view.facelets.FaceletHandler

public class SetTagHandler
extends AliasTagHandler

Tag handler that exposes a variable to the variable map. Behaviour is close to the c:set tag handler except:

• It allows caching a variable using cache parameter: variable will be resolved the first time is is called and will be put in the context after
• The resolved variable is removed from context when tag is closed to avoid filling the context with it
• Since 5.4, variables are made available in the request context after the JSF component tree build thanks to a backing component.

Since:

5.3.1

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.faces.view.facelets.TagAttribute	blockMerge
protected javax.faces.view.facelets.TagAttribute	blockPatterns
protected javax.faces.view.facelets.TagAttribute	local Determines in which context expression will be evaluated when expression is not cached and resolved twice (build time by default, render time if local).
protected javax.faces.view.facelets.TagAttribute	resolveTwice
protected javax.faces.view.facelets.TagAttribute	useAlias Force using of AliasVariableMapper logics, exposing a reference of to a value that might change between "restore view" and "render response" phase, to make sure it's not cached by components and resolved again at "render response" phase.
protected javax.faces.view.facelets.TagAttribute	value
protected javax.faces.view.facelets.TagAttribute	var

Fields inherited from class org.nuxeo.ecm.platform.ui.web.binding.alias.AliasTagHandler

anchor, ANCHOR_ENABLED_VARIABLE, blockedPatterns, cache, id, variables

Fields inherited from class javax.faces.view.facelets.DelegatingMetaTagHandler

delegateFactory

Fields inherited from class javax.faces.view.facelets.TagHandler

nextHandler, tag, tagId

Constructor Summary

Constructors

Constructor and Description
SetTagHandler(javax.faces.view.facelets.ComponentConfig config)

Method Summary

Modifier and Type	Method and Description
void	apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent)
void	applyAlias(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent)
javax.faces.view.facelets.FaceletHandler	applyOptimized(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, BlockingVariableMapper vm)
javax.faces.view.facelets.FaceletHandler	applyOptimized(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, BlockingVariableMapper vm, String varStr)
javax.faces.view.facelets.FaceletHandler	getAliasVariableMapper(javax.faces.view.facelets.FaceletContext ctx, AliasVariableMapper target)
javax.faces.view.facelets.FaceletHandler	getNextHandler()
boolean	isAcceptingMerge(javax.faces.view.facelets.FaceletContext ctx)
boolean	isAcceptingMerge(javax.faces.view.facelets.FaceletContext ctx, BlockingVariableMapper vm, String var)
protected List<String>	resolveBlockPatterns(String value)

Methods inherited from class org.nuxeo.ecm.platform.ui.web.binding.alias.AliasTagHandler

apply, applyAlias, applyAliasHandler, applyCompat, applyOptimized, isAnchored, isOptimizedAgain

Methods inherited from class javax.faces.view.facelets.ComponentHandler

createComponent, getComponentConfig, getTagHandlerDelegate, isNew, onComponentCreated, onComponentPopulated

Methods inherited from class javax.faces.view.facelets.DelegatingMetaTagHandler

applyNextHandler, createMetaRuleset, getBinding, getTag, getTagAttribute, getTagId, isDisabled, setAttributes

Methods inherited from class javax.faces.view.facelets.TagHandler

getAttribute, getRequiredAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

var

protected final javax.faces.view.facelets.TagAttribute var

value

protected final javax.faces.view.facelets.TagAttribute value

resolveTwice

protected final javax.faces.view.facelets.TagAttribute resolveTwice

Since:

5.5

blockPatterns

protected final javax.faces.view.facelets.TagAttribute blockPatterns

Since:

5.6

blockMerge

protected final javax.faces.view.facelets.TagAttribute blockMerge

Since:

5.9.2

local

protected final javax.faces.view.facelets.TagAttribute local

Determines in which context expression will be evaluated when expression is not cached and resolved twice (build time by default, render time if local).

Since:

7.10

useAlias

protected final javax.faces.view.facelets.TagAttribute useAlias

Force using of AliasVariableMapper logics, exposing a reference of to a value that might change between "restore view" and "render response" phase, to make sure it's not cached by components and resolved again at "render response" phase.

Since:

8.2

Constructor Detail

SetTagHandler

public SetTagHandler(javax.faces.view.facelets.ComponentConfig config)

Method Detail

apply

public void apply(javax.faces.view.facelets.FaceletContext ctx,
                  javax.faces.component.UIComponent parent)
           throws IOException,
                  javax.faces.FacesException,
                  javax.faces.view.facelets.FaceletException,
                  javax.el.ELException

Specified by:

apply in interface javax.faces.view.facelets.FaceletHandler

Overrides:

apply in class AliasTagHandler

Throws:

IOException

javax.faces.FacesException

javax.faces.view.facelets.FaceletException

javax.el.ELException

getNextHandler

public javax.faces.view.facelets.FaceletHandler getNextHandler()

isAcceptingMerge

public boolean isAcceptingMerge(javax.faces.view.facelets.FaceletContext ctx,
                                BlockingVariableMapper vm,
                                String var)

isAcceptingMerge

public boolean isAcceptingMerge(javax.faces.view.facelets.FaceletContext ctx)

applyOptimized

public javax.faces.view.facelets.FaceletHandler applyOptimized(javax.faces.view.facelets.FaceletContext ctx,
                                                               javax.faces.component.UIComponent parent,
                                                               BlockingVariableMapper vm)
                                                        throws IOException

Throws:

IOException

applyOptimized

public javax.faces.view.facelets.FaceletHandler applyOptimized(javax.faces.view.facelets.FaceletContext ctx,
                                                               javax.faces.component.UIComponent parent,
                                                               BlockingVariableMapper vm,
                                                               String varStr)
                                                        throws IOException

Throws:

IOException

applyAlias

public void applyAlias(javax.faces.view.facelets.FaceletContext ctx,
                       javax.faces.component.UIComponent parent)
                throws IOException

Throws:

IOException

getAliasVariableMapper

public javax.faces.view.facelets.FaceletHandler getAliasVariableMapper(javax.faces.view.facelets.FaceletContext ctx,
                                                                       AliasVariableMapper target)

resolveBlockPatterns

protected List<String> resolveBlockPatterns(String value)