Class LayoutTypeConfigurationImpl
- java.lang.Object
-
- org.nuxeo.ecm.platform.forms.layout.api.impl.LayoutTypeConfigurationImpl
-
- All Implemented Interfaces:
Serializable
,LayoutTypeConfiguration
public class LayoutTypeConfigurationImpl extends Object implements LayoutTypeConfiguration
- Since:
- 6.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<String>
categories
protected boolean
containingForm
protected Map<String,Map<String,Serializable>>
defaultPropertyValues
protected String
demoId
protected boolean
demoPreviewEnabled
protected String
deprecatedVersion
protected String
description
protected Map<String,List<LayoutDefinition>>
fieldLayouts
protected boolean
handlingLabels
protected Map<String,List<LayoutDefinition>>
propertyLayouts
protected String
sinceVersion
protected List<String>
supportedControls
protected List<String>
supportedModes
protected String
title
-
Constructor Summary
Constructors Constructor Description LayoutTypeConfigurationImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
List<String>
getCategories()
Map<String,Map<String,Serializable>>
getDefaultPropertyValues()
Returns the default values for the layout type properties, by mode.Map<String,Serializable>
getDefaultPropertyValues(String mode)
Returns the default values for the layout type properties, for given mode.String
getDemoId()
Returns the identifier to be used for the demo, or null if no demo is available.String
getDeprecatedVersion()
Returns the version name since the widget type has been deprecated (5.4, 5.4.2, etc...)String
getDescription()
protected List<LayoutDefinition>
getLayouts(Map<String,List<LayoutDefinition>> allLayouts, String mode, String additionalMode)
Map<String,List<LayoutDefinition>>
getPropertyLayouts()
List<LayoutDefinition>
getPropertyLayouts(String mode, String additionalMode)
String
getSinceVersion()
Returns the version name since the widget type has been available (5.4, 5.4.2, etc...)List<String>
getSupportedControls()
Returns the list of supported controls, e.g.List<String>
getSupportedModes()
String
getTitle()
boolean
isContainingForm()
Returns true if widget will be containing forms.boolean
isDemoPreviewEnabled()
Returns true is the preview is enabled on the demo.boolean
isHandlingLabels()
Returns true if widget knows how to display its label (some widget types might delegate this to their containing widget or layout, usually when defining form layouts).void
setCategories(List<String> categories)
void
setContainingForm(boolean containingForm)
void
setDefaultPropertyValues(Map<String,Map<String,Serializable>> defaultPropertyValues)
void
setDemoId(String demoId)
void
setDemoPreviewEnabled(boolean demoPreviewEnabled)
void
setDeprecatedVersion(String deprecatedVersion)
void
setDescription(String description)
void
setHandlingLabels(boolean handlingLabels)
void
setPropertyLayouts(Map<String,List<LayoutDefinition>> propertyLayouts)
void
setSinceVersion(String sinceVersion)
void
setSupportedControls(List<String> supportedControls)
void
setSupportedModes(List<String> supportedModes)
void
setTitle(String title)
-
-
-
Field Detail
-
sinceVersion
protected String sinceVersion
-
deprecatedVersion
protected String deprecatedVersion
-
description
protected String description
-
demoPreviewEnabled
protected boolean demoPreviewEnabled
-
supportedModes
protected List<String> supportedModes
-
handlingLabels
protected boolean handlingLabels
-
supportedControls
protected List<String> supportedControls
-
containingForm
protected boolean containingForm
-
categories
protected List<String> categories
-
propertyLayouts
protected Map<String,List<LayoutDefinition>> propertyLayouts
-
defaultPropertyValues
protected Map<String,Map<String,Serializable>> defaultPropertyValues
-
fieldLayouts
protected Map<String,List<LayoutDefinition>> fieldLayouts
-
-
Constructor Detail
-
LayoutTypeConfigurationImpl
public LayoutTypeConfigurationImpl()
-
-
Method Detail
-
getSinceVersion
public String getSinceVersion()
Description copied from interface:LayoutTypeConfiguration
Returns the version name since the widget type has been available (5.4, 5.4.2, etc...)- Specified by:
getSinceVersion
in interfaceLayoutTypeConfiguration
-
setSinceVersion
public void setSinceVersion(String sinceVersion)
-
getDeprecatedVersion
public String getDeprecatedVersion()
Description copied from interface:LayoutTypeConfiguration
Returns the version name since the widget type has been deprecated (5.4, 5.4.2, etc...)- Specified by:
getDeprecatedVersion
in interfaceLayoutTypeConfiguration
-
setDeprecatedVersion
public void setDeprecatedVersion(String deprecatedVersion)
-
getTitle
public String getTitle()
- Specified by:
getTitle
in interfaceLayoutTypeConfiguration
-
getDescription
public String getDescription()
- Specified by:
getDescription
in interfaceLayoutTypeConfiguration
-
setDescription
public void setDescription(String description)
-
getDemoId
public String getDemoId()
Description copied from interface:LayoutTypeConfiguration
Returns the identifier to be used for the demo, or null if no demo is available.- Specified by:
getDemoId
in interfaceLayoutTypeConfiguration
-
isDemoPreviewEnabled
public boolean isDemoPreviewEnabled()
Description copied from interface:LayoutTypeConfiguration
Returns true is the preview is enabled on the demo.- Specified by:
isDemoPreviewEnabled
in interfaceLayoutTypeConfiguration
-
setDemoPreviewEnabled
public void setDemoPreviewEnabled(boolean demoPreviewEnabled)
-
getSupportedModes
public List<String> getSupportedModes()
- Specified by:
getSupportedModes
in interfaceLayoutTypeConfiguration
-
setSupportedModes
public void setSupportedModes(List<String> supportedModes)
-
isHandlingLabels
public boolean isHandlingLabels()
Description copied from interface:LayoutTypeConfiguration
Returns true if widget knows how to display its label (some widget types might delegate this to their containing widget or layout, usually when defining form layouts).- Specified by:
isHandlingLabels
in interfaceLayoutTypeConfiguration
-
setHandlingLabels
public void setHandlingLabels(boolean handlingLabels)
-
getSupportedControls
public List<String> getSupportedControls()
Description copied from interface:LayoutTypeConfiguration
Returns the list of supported controls, e.g. controls that are checked on sub-widgets definitions.- Specified by:
getSupportedControls
in interfaceLayoutTypeConfiguration
-
setSupportedControls
public void setSupportedControls(List<String> supportedControls)
-
isContainingForm
public boolean isContainingForm()
Description copied from interface:LayoutTypeConfiguration
Returns true if widget will be containing forms.Since forms cannot contains any sub forms, layouts using this widget should not be surrounded by any form. Other widgets in the same layouts not containing forms may then need a surrounding form that could be added by the layout template.
- Specified by:
isContainingForm
in interfaceLayoutTypeConfiguration
-
setContainingForm
public void setContainingForm(boolean containingForm)
-
getCategories
public List<String> getCategories()
- Specified by:
getCategories
in interfaceLayoutTypeConfiguration
-
setCategories
public void setCategories(List<String> categories)
-
getPropertyLayouts
public Map<String,List<LayoutDefinition>> getPropertyLayouts()
- Specified by:
getPropertyLayouts
in interfaceLayoutTypeConfiguration
-
getPropertyLayouts
public List<LayoutDefinition> getPropertyLayouts(String mode, String additionalMode)
- Specified by:
getPropertyLayouts
in interfaceLayoutTypeConfiguration
-
setPropertyLayouts
public void setPropertyLayouts(Map<String,List<LayoutDefinition>> propertyLayouts)
-
getDefaultPropertyValues
public Map<String,Map<String,Serializable>> getDefaultPropertyValues()
Description copied from interface:LayoutTypeConfiguration
Returns the default values for the layout type properties, by mode.- Specified by:
getDefaultPropertyValues
in interfaceLayoutTypeConfiguration
-
getDefaultPropertyValues
public Map<String,Serializable> getDefaultPropertyValues(String mode)
Description copied from interface:LayoutTypeConfiguration
Returns the default values for the layout type properties, for given mode.- Specified by:
getDefaultPropertyValues
in interfaceLayoutTypeConfiguration
-
setDefaultPropertyValues
public void setDefaultPropertyValues(Map<String,Map<String,Serializable>> defaultPropertyValues)
-
getLayouts
protected List<LayoutDefinition> getLayouts(Map<String,List<LayoutDefinition>> allLayouts, String mode, String additionalMode)
-
-