org.nuxeo.ecm.platform.forms.layout.api
Interface WidgetTypeConfiguration

All Superinterfaces:

Serializable

All Known Implementing Classes:

WidgetTypeConfigurationDescriptor, WidgetTypeConfigurationImpl

public interface WidgetTypeConfiguration
extends Serializable

Widget configuration interface

Since:

5.4

Author:

Anahide Tchertchian

Method Summary

List<String>	getCategories()
Map<String,Serializable>	getConfProperties() Returns configuration properties.
Serializable	getConfProperty(String propName)
List<FieldDefinition>	getDefaultFieldDefinitions()
List<String>	getDefaultFieldTypes()
String	getDemoId() Returns the identifier to be used for the demo, or null if no demo is available.
String	getDescription()
Map<String,List<LayoutDefinition>>	getPropertyLayouts()
List<LayoutDefinition>	getPropertyLayouts(String mode, String additionalMode)
String	getSinceVersion()
List<String>	getSupportedFieldTypes()
List<String>	getSupportedModes()
String	getTitle()
boolean	isAcceptingSubWidgets()
boolean	isComplex()
boolean	isDemoPreviewEnabled() Returns true is the preview is enabled on the demo.
boolean	isList()

Method Detail

getSinceVersion

String getSinceVersion()

getTitle

String getTitle()

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()

isList

boolean isList()

isComplex

boolean isComplex()

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()