org.nuxeo.ecm.platform.forms.layout.facelets

Class LayoutTagHandler

java.lang.Object

javax.faces.view.facelets.TagHandler

org.nuxeo.ecm.platform.forms.layout.facelets.LayoutTagHandler

All Implemented Interfaces:

javax.faces.view.facelets.FaceletHandler

public class LayoutTagHandler
extends javax.faces.view.facelets.TagHandler

Layout tag handler.

Computes a layout in given facelet context, for given mode and value attributes. The layout can either be computed from a layout definition, or by a layout name, where the layout service will lookup the corresponding definition.

If a template is found for this layout, include the corresponding facelet and use facelet template features to iterate over rows and widgets.

Since 5.6, the layout name attribute also accepts a comma separated list of layout names.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.faces.view.facelets.TagAttribute	category
protected javax.faces.view.facelets.TagConfig	config
protected javax.faces.view.facelets.TagAttribute	definition
protected javax.faces.view.facelets.TagAttribute	layout The layout instance to render, instead of resolving it from a name or definition
protected javax.faces.view.facelets.TagAttribute	mode
protected javax.faces.view.facelets.TagAttribute	name
protected String[]	reservedVarsArray
protected javax.faces.view.facelets.TagAttribute	resolveOnly Parameter used to specify that layout should not be rendered, only resolved and exposed to the context.
protected javax.faces.view.facelets.TagAttribute	selectAllByDefault
protected javax.faces.view.facelets.TagAttribute	selectedColumns
protected javax.faces.view.facelets.TagAttribute	selectedRows
protected javax.faces.view.facelets.TagAttribute	template
protected javax.faces.view.facelets.TagAttribute	value
protected javax.faces.view.facelets.TagAttribute[]	vars

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

nextHandler, tag, tagId

Constructor Summary

Constructors

Constructor and Description
LayoutTagHandler(javax.faces.view.facelets.TagConfig config)

Method Summary

Modifier and Type	Method and Description
void	apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent)
protected void	applyErrorHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, FaceletHandlerHelper helper, String message)
protected void	applyLayoutHandler(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent, FaceletHandlerHelper helper, WebLayoutManager layoutService, Layout layoutInstance, String templateValue, Map<String,Serializable> additionalProps, Map<String,javax.el.ValueExpression> vars, boolean resolveOnly)
protected javax.faces.view.facelets.FaceletHandler	getDevFaceletHandler(javax.faces.view.facelets.FaceletContext ctx, FaceletHandlerHelper helper, javax.faces.view.facelets.TagConfig config, Layout layout)
protected Map<String,javax.el.ValueExpression>	getVariablesForLayoutBuild(javax.faces.view.facelets.FaceletContext ctx, String modeValue)
protected Map<String,javax.el.ValueExpression>	getVariablesForLayoutRendering(javax.faces.view.facelets.FaceletContext ctx, WebLayoutManager layoutService, Layout layoutInstance) Computes variables for rendering, making available the layout instance and its properties to the context.
protected List<String>	resolveLayoutNames(String nameValue) Resolves layouts names, splitting on character "," and trimming resulting names, and allowing empty strings if the whole string is not empty to ease up rendering of layout names using variables.

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

config

protected final javax.faces.view.facelets.TagConfig config

layout

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

The layout instance to render, instead of resolving it from a name or definition

Since:

5.7

name

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

category

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

Since:

5.5.

definition

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

Since:

5.4.2

mode

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

value

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

template

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

selectedRows

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

selectedColumns

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

selectAllByDefault

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

resolveOnly

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

Parameter used to specify that layout should not be rendered, only resolved and exposed to the context.

Since:

5.7

vars

protected final javax.faces.view.facelets.TagAttribute[] vars

reservedVarsArray

protected final String[] reservedVarsArray

Constructor Detail

LayoutTagHandler

public LayoutTagHandler(javax.faces.view.facelets.TagConfig config)

Method Detail

apply

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

Throws:

IOException

javax.faces.FacesException

javax.el.ELException

resolveLayoutNames

protected List<String> resolveLayoutNames(String nameValue)

Resolves layouts names, splitting on character "," and trimming resulting names, and allowing empty strings if the whole string is not empty to ease up rendering of layout names using variables.

For instance, if value is null or empty, will return a single empty layout name "". If value is "," it will return an empty list, triggering no error for usage like

applyLayoutHandler

protected void applyLayoutHandler(javax.faces.view.facelets.FaceletContext ctx,
                                  javax.faces.component.UIComponent parent,
                                  FaceletHandlerHelper helper,
                                  WebLayoutManager layoutService,
                                  Layout layoutInstance,
                                  String templateValue,
                                  Map<String,Serializable> additionalProps,
                                  Map<String,javax.el.ValueExpression> vars,
                                  boolean resolveOnly)
                           throws IOException,
                                  javax.faces.FacesException,
                                  javax.el.ELException

Throws:

IOException

javax.faces.FacesException

javax.el.ELException

getVariablesForLayoutBuild

protected Map<String,javax.el.ValueExpression> getVariablesForLayoutBuild(javax.faces.view.facelets.FaceletContext ctx,
                                                                          String modeValue)

getVariablesForLayoutRendering

protected Map<String,javax.el.ValueExpression> getVariablesForLayoutRendering(javax.faces.view.facelets.FaceletContext ctx,
                                                                              WebLayoutManager layoutService,
                                                                              Layout layoutInstance)

Computes variables for rendering, making available the layout instance and its properties to the context.

applyErrorHandler

protected void applyErrorHandler(javax.faces.view.facelets.FaceletContext ctx,
                                 javax.faces.component.UIComponent parent,
                                 FaceletHandlerHelper helper,
                                 String message)
                          throws IOException

Throws:

IOException

getDevFaceletHandler

protected javax.faces.view.facelets.FaceletHandler getDevFaceletHandler(javax.faces.view.facelets.FaceletContext ctx,
                                                                        FaceletHandlerHelper helper,
                                                                        javax.faces.view.facelets.TagConfig config,
                                                                        Layout layout)