Class LayoutTypeConfigurationImpl
java.lang.Object
org.nuxeo.ecm.platform.forms.layout.api.impl.LayoutTypeConfigurationImpl
- All Implemented Interfaces:
Serializable
,LayoutTypeConfiguration
- Since:
- 6.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected Map<String,
Map<String, Serializable>> protected String
protected boolean
protected String
protected String
protected Map<String,
List<LayoutDefinition>> protected boolean
protected Map<String,
List<LayoutDefinition>> protected String
protected String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the default values for the layout type properties, by mode.Returns the default values for the layout type properties, for given mode.Returns the identifier to be used for the demo, or null if no demo is available.Returns the version name since the widget type has been deprecated (5.4, 5.4.2, etc...)protected List<LayoutDefinition>
getLayouts
(Map<String, List<LayoutDefinition>> allLayouts, String mode, String additionalMode) getPropertyLayouts
(String mode, String additionalMode) Returns the version name since the widget type has been available (5.4, 5.4.2, etc...)Returns the list of supported controls, e.g. controls that are checked on sub-widgets definitions.getTitle()
boolean
Returns true if widget will be containing forms.boolean
Returns true is the preview is enabled on the demo.boolean
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
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
-
Field Details
-
sinceVersion
-
deprecatedVersion
-
title
-
description
-
demoId
-
demoPreviewEnabled
protected boolean demoPreviewEnabled -
supportedModes
-
handlingLabels
protected boolean handlingLabels -
supportedControls
-
containingForm
protected boolean containingForm -
categories
-
propertyLayouts
-
defaultPropertyValues
-
fieldLayouts
-
-
Constructor Details
-
LayoutTypeConfigurationImpl
public LayoutTypeConfigurationImpl()
-
-
Method Details
-
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
-
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
-
getTitle
- Specified by:
getTitle
in interfaceLayoutTypeConfiguration
-
setTitle
-
getDescription
- Specified by:
getDescription
in interfaceLayoutTypeConfiguration
-
setDescription
-
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
-
setDemoId
-
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
- Specified by:
getSupportedModes
in interfaceLayoutTypeConfiguration
-
setSupportedModes
-
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
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
-
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
- Specified by:
getCategories
in interfaceLayoutTypeConfiguration
-
setCategories
-
getPropertyLayouts
- Specified by:
getPropertyLayouts
in interfaceLayoutTypeConfiguration
-
getPropertyLayouts
- Specified by:
getPropertyLayouts
in interfaceLayoutTypeConfiguration
-
setPropertyLayouts
-
getDefaultPropertyValues
Description copied from interface:LayoutTypeConfiguration
Returns the default values for the layout type properties, by mode.- Specified by:
getDefaultPropertyValues
in interfaceLayoutTypeConfiguration
-
getDefaultPropertyValues
Description copied from interface:LayoutTypeConfiguration
Returns the default values for the layout type properties, for given mode.- Specified by:
getDefaultPropertyValues
in interfaceLayoutTypeConfiguration
-
setDefaultPropertyValues
-
getLayouts
protected List<LayoutDefinition> getLayouts(Map<String, List<LayoutDefinition>> allLayouts, String mode, String additionalMode) -
equals
-