org.nuxeo.ecm.platform.forms.layout.descriptors
Class WidgetTypeConfigurationDescriptor

java.lang.Object
  org.nuxeo.ecm.platform.forms.layout.descriptors.WidgetTypeConfigurationDescriptor

All Implemented Interfaces:

Serializable, WidgetTypeConfiguration

public class WidgetTypeConfigurationDescriptor
extends Object
implements WidgetTypeConfiguration

Descriptor for a widget type configuration

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Constructor Summary

WidgetTypeConfigurationDescriptor()

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()
void	setConfProperties(PropertiesDescriptor propsDesc)
void	setDescription(DocumentFragment descriptionDOM)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WidgetTypeConfigurationDescriptor

public WidgetTypeConfigurationDescriptor()

Method Detail

getCategories

public List<String> getCategories()

Specified by:

getCategories in interface WidgetTypeConfiguration

getDescription

public String getDescription()

Specified by:

getDescription in interface WidgetTypeConfiguration

setDescription

public void setDescription(DocumentFragment descriptionDOM)

getTitle

public String getTitle()

Specified by:

getTitle in interface WidgetTypeConfiguration

getDemoId

public String getDemoId()

Description copied from interface: WidgetTypeConfiguration

Returns the identifier to be used for the demo, or null if no demo is available.

Specified by:

getDemoId in interface WidgetTypeConfiguration

isDemoPreviewEnabled

public boolean isDemoPreviewEnabled()

Description copied from interface: WidgetTypeConfiguration

Returns true is the preview is enabled on the demo.

Specified by:

isDemoPreviewEnabled in interface WidgetTypeConfiguration

isAcceptingSubWidgets

public boolean isAcceptingSubWidgets()

Specified by:

isAcceptingSubWidgets in interface WidgetTypeConfiguration

isComplex

public boolean isComplex()

Specified by:

isComplex in interface WidgetTypeConfiguration

isList

public boolean isList()

Specified by:

isList in interface WidgetTypeConfiguration

getDefaultFieldTypes

public List<String> getDefaultFieldTypes()

Specified by:

getDefaultFieldTypes in interface WidgetTypeConfiguration

getSupportedFieldTypes

public List<String> getSupportedFieldTypes()

Specified by:

getSupportedFieldTypes in interface WidgetTypeConfiguration

getDefaultFieldDefinitions

public List<FieldDefinition> getDefaultFieldDefinitions()

Specified by:

getDefaultFieldDefinitions in interface WidgetTypeConfiguration

getConfProperties

public Map<String,Serializable> getConfProperties()

Description copied from interface: WidgetTypeConfiguration

Returns configuration properties.

Specified by:

getConfProperties in interface WidgetTypeConfiguration

getConfProperty

public Serializable getConfProperty(String propName)

Specified by:

getConfProperty in interface WidgetTypeConfiguration

setConfProperties

public void setConfProperties(PropertiesDescriptor propsDesc)

getPropertyLayouts

public List<LayoutDefinition> getPropertyLayouts(String mode,
                                                 String additionalMode)

Specified by:

getPropertyLayouts in interface WidgetTypeConfiguration

getPropertyLayouts

public Map<String,List<LayoutDefinition>> getPropertyLayouts()

Specified by:

getPropertyLayouts in interface WidgetTypeConfiguration

getSinceVersion

public String getSinceVersion()

Specified by:

getSinceVersion in interface WidgetTypeConfiguration

getSupportedModes

public List<String> getSupportedModes()

Specified by:

getSupportedModes in interface WidgetTypeConfiguration