public interface WidgetTypeConfiguration extends Serializable
Modifier and Type | Method and 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() |
String getSinceVersion()
String getDeprecatedVersion()
String getTitle()
String getDescription()
String getDemoId()
boolean isDemoPreviewEnabled()
boolean isAcceptingSubWidgets()
boolean isHandlingLabels()
boolean isList()
boolean isComplex()
boolean isContainingForm()
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.
List<FieldDefinition> getDefaultFieldDefinitions()
Map<String,Serializable> getConfProperties()
Serializable getConfProperty(String propName)
List<LayoutDefinition> getPropertyLayouts(String mode, String additionalMode)
Map<String,List<LayoutDefinition>> getPropertyLayouts()
List<LayoutDefinition> getFieldLayouts(String mode, String additionalMode)
These layouts are used to document accepted fields on the widget type, depending on the rendering mode.
mode
- the mode to retrieve layouts for.additionalMode
- additional mode to take into account, typically BuiltinModes.ANY
Map<String,List<LayoutDefinition>> getFieldLayouts()
getFieldLayouts(String, String)
Map<String,Map<String,Serializable>> getDefaultPropertyValues()
Map<String,Serializable> getDefaultPropertyValues(String mode)
Map<String,Map<String,Serializable>> getDefaultControlValues()
Map<String,Serializable> getDefaultControlValues(String mode)
Copyright © 2015 Nuxeo SA. All rights reserved.