public class WidgetTypeConfigurationImpl extends Object implements WidgetTypeConfiguration
Constructor and Description |
---|
WidgetTypeConfigurationImpl() |
WidgetTypeConfigurationImpl(String sinceVersion,
String title,
String description,
String demoId,
boolean demoPreviewEnabled,
Map<String,Serializable> properties,
List<String> supportedModes,
boolean acceptingSubWidgets,
boolean list,
boolean complex,
boolean containingForm,
List<String> supportedFieldTypes,
List<String> defaultFieldTypes,
List<FieldDefinition> defaultFieldDefinitions,
List<String> categories,
Map<String,List<LayoutDefinition>> propertyLayouts)
Deprecated.
since 5.6: use setters instead
|
WidgetTypeConfigurationImpl(String sinceVersion,
String title,
String description,
String demoId,
boolean demoPreviewEnabled,
Map<String,Serializable> properties,
List<String> supportedModes,
boolean acceptingSubWidgets,
boolean list,
boolean complex,
List<String> supportedFieldTypes,
List<String> defaultFieldTypes,
List<FieldDefinition> defaultFieldDefinitions,
List<String> categories,
Map<String,List<LayoutDefinition>> propertyLayouts)
Deprecated.
since 5.6: use setters instead
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
List<String> |
getCategories() |
Map<String,Serializable> |
getConfProperties()
Returns configuration properties.
|
Serializable |
getConfProperty(String propName) |
Map<String,Map<String,Serializable>> |
getDefaultControlValues() |
Map<String,Serializable> |
getDefaultControlValues(String mode) |
List<FieldDefinition> |
getDefaultFieldDefinitions() |
List<String> |
getDefaultFieldTypes() |
Map<String,Map<String,Serializable>> |
getDefaultPropertyValues()
Returns the default values for the widget type properties, by mode.
|
Map<String,Serializable> |
getDefaultPropertyValues(String mode)
Returns the default values for the widget 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() |
Map<String,List<LayoutDefinition>> |
getFieldLayouts()
Returns the map of field layouts per mode.
|
List<LayoutDefinition> |
getFieldLayouts(String mode,
String additionalMode)
Returns the list of layouts for given mode and additional modes.
|
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> |
getSupportedFieldTypes() |
List<String> |
getSupportedModes() |
String |
getTitle() |
boolean |
isAcceptingSubWidgets() |
boolean |
isComplex() |
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).
|
boolean |
isList() |
void |
setAcceptingSubWidgets(boolean acceptingSubWidgets) |
void |
setCategories(List<String> categories) |
void |
setComplex(boolean complex) |
void |
setContainingForm(boolean containingForm) |
void |
setDefaultControlValues(Map<String,Map<String,Serializable>> values) |
void |
setDefaultFieldDefinitions(List<FieldDefinition> defaultFieldDefinitions) |
void |
setDefaultFieldTypes(List<String> defaultFieldTypes) |
void |
setDefaultPropertyValues(Map<String,Map<String,Serializable>> values) |
void |
setDemoId(String demoId) |
void |
setDemoPreviewEnabled(boolean demoPreviewEnabled) |
void |
setDeprecatedVersion(String deprecatedVersion) |
void |
setDescription(String description) |
void |
setFieldLayouts(Map<String,List<LayoutDefinition>> fieldLayouts) |
void |
setHandlingLabels(boolean handlingLabels) |
void |
setList(boolean list) |
void |
setProperties(Map<String,Serializable> properties) |
void |
setPropertyLayouts(Map<String,List<LayoutDefinition>> propertyLayouts) |
void |
setSinceVersion(String sinceVersion) |
void |
setSupportedControls(List<String> supportedControls) |
void |
setSupportedFieldTypes(List<String> supportedFieldTypes) |
void |
setSupportedModes(List<String> supportedModes) |
void |
setTitle(String title) |
public WidgetTypeConfigurationImpl()
@Deprecated public WidgetTypeConfigurationImpl(String sinceVersion, String title, String description, String demoId, boolean demoPreviewEnabled, Map<String,Serializable> properties, List<String> supportedModes, boolean acceptingSubWidgets, boolean list, boolean complex, List<String> supportedFieldTypes, List<String> defaultFieldTypes, List<FieldDefinition> defaultFieldDefinitions, List<String> categories, Map<String,List<LayoutDefinition>> propertyLayouts)
@Deprecated public WidgetTypeConfigurationImpl(String sinceVersion, String title, String description, String demoId, boolean demoPreviewEnabled, Map<String,Serializable> properties, List<String> supportedModes, boolean acceptingSubWidgets, boolean list, boolean complex, boolean containingForm, List<String> supportedFieldTypes, List<String> defaultFieldTypes, List<FieldDefinition> defaultFieldDefinitions, List<String> categories, Map<String,List<LayoutDefinition>> propertyLayouts)
public String getSinceVersion()
WidgetTypeConfiguration
getSinceVersion
in interface WidgetTypeConfiguration
public String getDeprecatedVersion()
WidgetTypeConfiguration
getDeprecatedVersion
in interface WidgetTypeConfiguration
public String getTitle()
getTitle
in interface WidgetTypeConfiguration
public String getDescription()
getDescription
in interface WidgetTypeConfiguration
public String getDemoId()
WidgetTypeConfiguration
getDemoId
in interface WidgetTypeConfiguration
public boolean isDemoPreviewEnabled()
WidgetTypeConfiguration
isDemoPreviewEnabled
in interface WidgetTypeConfiguration
public Map<String,Serializable> getConfProperties()
WidgetTypeConfiguration
getConfProperties
in interface WidgetTypeConfiguration
public Serializable getConfProperty(String propName)
getConfProperty
in interface WidgetTypeConfiguration
public List<String> getSupportedModes()
getSupportedModes
in interface WidgetTypeConfiguration
public boolean isAcceptingSubWidgets()
isAcceptingSubWidgets
in interface WidgetTypeConfiguration
public boolean isList()
isList
in interface WidgetTypeConfiguration
public boolean isComplex()
isComplex
in interface WidgetTypeConfiguration
public boolean isContainingForm()
WidgetTypeConfiguration
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.
isContainingForm
in interface WidgetTypeConfiguration
public List<String> getSupportedFieldTypes()
getSupportedFieldTypes
in interface WidgetTypeConfiguration
public List<String> getDefaultFieldTypes()
getDefaultFieldTypes
in interface WidgetTypeConfiguration
public List<FieldDefinition> getDefaultFieldDefinitions()
getDefaultFieldDefinitions
in interface WidgetTypeConfiguration
public List<String> getCategories()
getCategories
in interface WidgetTypeConfiguration
public Map<String,List<LayoutDefinition>> getPropertyLayouts()
getPropertyLayouts
in interface WidgetTypeConfiguration
public List<LayoutDefinition> getLayouts(Map<String,List<LayoutDefinition>> allLayouts, String mode, String additionalMode)
public List<LayoutDefinition> getPropertyLayouts(String mode, String additionalMode)
getPropertyLayouts
in interface WidgetTypeConfiguration
public void setSinceVersion(String sinceVersion)
public void setDeprecatedVersion(String deprecatedVersion)
public void setTitle(String title)
public void setDescription(String description)
public void setDemoId(String demoId)
public void setDemoPreviewEnabled(boolean demoPreviewEnabled)
public void setProperties(Map<String,Serializable> properties)
public void setAcceptingSubWidgets(boolean acceptingSubWidgets)
public void setList(boolean list)
public void setComplex(boolean complex)
public void setContainingForm(boolean containingForm)
public void setSupportedFieldTypes(List<String> supportedFieldTypes)
public void setDefaultFieldDefinitions(List<FieldDefinition> defaultFieldDefinitions)
public void setPropertyLayouts(Map<String,List<LayoutDefinition>> propertyLayouts)
public boolean isHandlingLabels()
WidgetTypeConfiguration
isHandlingLabels
in interface WidgetTypeConfiguration
public void setHandlingLabels(boolean handlingLabels)
public Map<String,Map<String,Serializable>> getDefaultPropertyValues()
WidgetTypeConfiguration
getDefaultPropertyValues
in interface WidgetTypeConfiguration
public Map<String,Serializable> getDefaultPropertyValues(String mode)
WidgetTypeConfiguration
getDefaultPropertyValues
in interface WidgetTypeConfiguration
public void setDefaultPropertyValues(Map<String,Map<String,Serializable>> values)
public Map<String,Map<String,Serializable>> getDefaultControlValues()
getDefaultControlValues
in interface WidgetTypeConfiguration
public Map<String,Serializable> getDefaultControlValues(String mode)
getDefaultControlValues
in interface WidgetTypeConfiguration
public void setDefaultControlValues(Map<String,Map<String,Serializable>> values)
public Map<String,List<LayoutDefinition>> getFieldLayouts()
WidgetTypeConfiguration
getFieldLayouts
in interface WidgetTypeConfiguration
WidgetTypeConfiguration.getFieldLayouts(String, String)
public List<LayoutDefinition> getFieldLayouts(String mode, String additionalMode)
WidgetTypeConfiguration
These layouts are used to document accepted fields on the widget type, depending on the rendering mode.
getFieldLayouts
in interface WidgetTypeConfiguration
mode
- the mode to retrieve layouts for.additionalMode
- additional mode to take into account, typically BuiltinModes.ANY
public void setFieldLayouts(Map<String,List<LayoutDefinition>> fieldLayouts)
public List<String> getSupportedControls()
WidgetTypeConfiguration
getSupportedControls
in interface WidgetTypeConfiguration
Copyright © 2015 Nuxeo SA. All rights reserved.