Package org.ametys.plugins.forms.helper

Class FormElementDefinitionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.helper.FormElementDefinitionHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormElementDefinitionHelper
extends AbstractLogEnabled
implements Serviceable, Component

Helper to create element definition for form

Field Summary

Fields

Modifier and Type	Field	Description
protected FormQuestionDataTypeExtensionPoint	_formQuestionDataTypeExtensionPoint	The form question data type extension point
static final String	ROLE	The extension point role.

Constructor Summary

Constructors

Constructor	Description
FormElementDefinitionHelper()

Method Summary

Modifier and Type	Method	Description
ElementDefinition	getElementDefinition(String name, String typeId, String labelKey, String descKey, Validator validator)	Create element definition
RepeaterDefinition	getRepeaterDefinition(String datapath, ElementDefinition[] childElements, String labelKey, String descKey, String addKey, String deleteKey, Integer maxSize)	Create repeater definition
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The extension point role.

_formQuestionDataTypeExtensionPoint

protected FormQuestionDataTypeExtensionPoint _formQuestionDataTypeExtensionPoint

The form question data type extension point

Constructor Details

FormElementDefinitionHelper

public FormElementDefinitionHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getElementDefinition

public ElementDefinition getElementDefinition(String name,
 String typeId,
 String labelKey,
 String descKey,
 Validator validator)

Create element definition

Parameters:

name - the name

typeId - the type id

labelKey - the label i18n key. Can be null.

descKey - the desc i18n key. Can be null.

validator - the validator. Can be null.

Returns:

the element definition

getRepeaterDefinition

public RepeaterDefinition getRepeaterDefinition(String datapath,
 ElementDefinition[] childElements,
 String labelKey,
 String descKey,
 String addKey,
 String deleteKey,
 Integer maxSize)

Create repeater definition

Parameters:

datapath - path of the parent element

childElements - the repeater's children

labelKey - the label i18n key. Can be null.

descKey - the desc i18n key. Can be null.

addKey - the add i18n key. Can be null.

deleteKey - the delete i18n key. Can be null.

maxSize - number maximum of entries

Returns:

the created repeater