org.nuxeo.ecm.platform.forms.layout.demo.jsf

Class PreviewLayoutDefinition

java.lang.Object

org.nuxeo.ecm.platform.forms.layout.demo.jsf.PreviewLayoutDefinition

All Implemented Interfaces:

Serializable

public class PreviewLayoutDefinition
extends Object
implements Serializable

Collects information to generate a layout definition from user information.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Map<String,Serializable>>	customProperties
protected Map<String,Serializable>	defaultProperties
protected List<String>	fields
protected Boolean	handlingLabels
protected String	helpLabel
protected String	label
protected Map<String,Serializable>	properties
protected List<WidgetDefinition>	subWidgets
protected Boolean	translated
protected String	widgetType

Constructor Summary

Constructors

Constructor and Description
PreviewLayoutDefinition(String widgetType, List<String> fields, Map<String,Serializable> defaultProperties)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Serializable>	cleanUpProperties(Map<String,Serializable> props) Removes empty properties as the JSF component may not accept empty values for some properties like "converter" or "validator".
protected Map<String,Serializable>	convertCustomProperties(List<Map<String,Serializable>> listProps, boolean ignoreErrors)
List<Map<String,Serializable>>	getCustomProperties()
List<FieldDefinition>	getFieldDefinitions()
List<String>	getFields()
Boolean	getHandlingLabels()
String	getHelpLabel()
String	getLabel()
Map<String,Serializable>	getNewCustomProperty()
Map<String,Serializable>	getProperties()
List<WidgetDefinition>	getSubWidgets()
Boolean	getTranslated()
Map<String,Serializable>	getWidgetProperties()
String	getWidgetType()
void	setCustomProperties(List<Map<String,Serializable>> customProperties)
void	setHandlingLabels(Boolean handlingLabels)
void	setHelpLabel(String helpLabel)
void	setLabel(String label)
void	setProperties(Map<String,Serializable> properties)
void	setSubWidgets(List<WidgetDefinition> subWidgets)
void	setTranslated(Boolean translated)
void	validateCustomProperties(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

widgetType

protected final String widgetType

fields

protected final List<String> fields

label

protected String label

helpLabel

protected String helpLabel

translated

protected Boolean translated

handlingLabels

protected Boolean handlingLabels

defaultProperties

protected Map<String,Serializable> defaultProperties

properties

protected Map<String,Serializable> properties

customProperties

protected List<Map<String,Serializable>> customProperties

subWidgets

protected List<WidgetDefinition> subWidgets

Constructor Detail

PreviewLayoutDefinition

public PreviewLayoutDefinition(String widgetType,
                               List<String> fields,
                               Map<String,Serializable> defaultProperties)

Method Detail

getWidgetType

public String getWidgetType()

getFields

public List<String> getFields()

getFieldDefinitions

public List<FieldDefinition> getFieldDefinitions()

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getHelpLabel

public String getHelpLabel()

setHelpLabel

public void setHelpLabel(String helpLabel)

getTranslated

public Boolean getTranslated()

setTranslated

public void setTranslated(Boolean translated)

getHandlingLabels

public Boolean getHandlingLabels()

setHandlingLabels

public void setHandlingLabels(Boolean handlingLabels)

getSubWidgets

public List<WidgetDefinition> getSubWidgets()

setSubWidgets

public void setSubWidgets(List<WidgetDefinition> subWidgets)

getProperties

public Map<String,Serializable> getProperties()

setProperties

public void setProperties(Map<String,Serializable> properties)

getCustomProperties

public List<Map<String,Serializable>> getCustomProperties()

setCustomProperties

public void setCustomProperties(List<Map<String,Serializable>> customProperties)

getWidgetProperties

public Map<String,Serializable> getWidgetProperties()

cleanUpProperties

protected Map<String,Serializable> cleanUpProperties(Map<String,Serializable> props)

Removes empty properties as the JSF component may not accept empty values for some properties like "converter" or "validator".

getNewCustomProperty

public Map<String,Serializable> getNewCustomProperty()

convertCustomProperties

protected Map<String,Serializable> convertCustomProperties(List<Map<String,Serializable>> listProps,
                                                           boolean ignoreErrors)
                                                    throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

validateCustomProperties

public void validateCustomProperties(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component,
                                     Object value)