Interface WidgetTypeConfiguration
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
WidgetTypeConfigurationImpl
public interface WidgetTypeConfiguration extends Serializable
Widget configuration interface- Since:
- 5.4
- Author:
- Anahide Tchertchian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.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()
-
-
-
Method Detail
-
getSinceVersion
String getSinceVersion()
Returns the version name since the widget type has been available (5.4, 5.4.2, etc...)
-
getDeprecatedVersion
String getDeprecatedVersion()
Returns the version name since the widget type has been deprecated (5.4, 5.4.2, etc...)- Since:
- 5.6
-
getDescription
String getDescription()
-
getDemoId
String getDemoId()
Returns the identifier to be used for the demo, or null if no demo is available.- Since:
- 5.4.2
-
isDemoPreviewEnabled
boolean isDemoPreviewEnabled()
Returns true is the preview is enabled on the demo.- Since:
- 5.4.2
-
getCategories
List<String> getCategories()
-
getSupportedModes
List<String> getSupportedModes()
-
isAcceptingSubWidgets
boolean isAcceptingSubWidgets()
-
isHandlingLabels
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).- Since:
- 5.6
-
isList
boolean isList()
-
isComplex
boolean isComplex()
-
isContainingForm
boolean isContainingForm()
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.
- Since:
- 5.6
-
getSupportedFieldTypes
List<String> getSupportedFieldTypes()
-
getDefaultFieldTypes
List<String> getDefaultFieldTypes()
-
getDefaultFieldDefinitions
List<FieldDefinition> getDefaultFieldDefinitions()
-
getConfProperties
Map<String,Serializable> getConfProperties()
Returns configuration properties.- Since:
- 5.4.2
-
getConfProperty
Serializable getConfProperty(String propName)
-
getPropertyLayouts
List<LayoutDefinition> getPropertyLayouts(String mode, String additionalMode)
-
getPropertyLayouts
Map<String,List<LayoutDefinition>> getPropertyLayouts()
-
getFieldLayouts
List<LayoutDefinition> getFieldLayouts(String mode, String additionalMode)
Returns the list of layouts for given mode and additional modes.These layouts are used to document accepted fields on the widget type, depending on the rendering mode.
- Parameters:
mode
- the mode to retrieve layouts for.additionalMode
- additional mode to take into account, typicallyBuiltinModes.ANY
- Since:
- 5.7.3
-
getFieldLayouts
Map<String,List<LayoutDefinition>> getFieldLayouts()
Returns the map of field layouts per mode.- Since:
- 5.7.3
- See Also:
getFieldLayouts(String, String)
-
getDefaultPropertyValues
Map<String,Map<String,Serializable>> getDefaultPropertyValues()
Returns the default values for the widget type properties, by mode.- Since:
- 5.7.3
-
getDefaultPropertyValues
Map<String,Serializable> getDefaultPropertyValues(String mode)
Returns the default values for the widget type properties, for given mode.- Since:
- 5.7.3
-
getDefaultControlValues
Map<String,Map<String,Serializable>> getDefaultControlValues()
- Since:
- 6.0
-
getDefaultControlValues
Map<String,Serializable> getDefaultControlValues(String mode)
- Since:
- 6.0
-
getSupportedControls
List<String> getSupportedControls()
Returns the list of supported controls, e.g. controls that are checked on sub-widgets definitions.- Since:
- 5.9.1
-
-