Package org.ametys.plugins.forms.question.types

Class AbstractStaticFormQuestionType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.question.types.AbstractStaticFormQuestionType

All Implemented Interfaces:

FormQuestionType, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

AbstractFormQuestionType, ComputedQuestionType, RichTextQuestionType

public abstract class AbstractStaticFormQuestionType
extends AbstractLogEnabled
implements FormQuestionType, Configurable, PluginAware, Serviceable

Static class for creating FormQuestionType from xml config

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nizableText	_category	The type category in button menu
protected I18nizableText	_description	Description of question type
protected Model	_formQuestionModel	The form question model
protected I18nUtils	_i18nUtils	I18n Utils
protected String	_iconGlyph	Icon glyph of question type
protected String	_id	Id of question type
protected I18nizableText	_label	Label of question type
protected String	_pluginName	Forms
protected Integer	_priority	The type priority in button menu
protected List<ClientSideElement.ScriptFile>	_scripts	Scripts associated with question type
protected String	_xslt	Xslt associated of question type

Constructor Summary

Constructors

Constructor	Description
AbstractStaticFormQuestionType()

Method Summary

Modifier and Type	Method	Description
protected SimpleViewItemGroup	_createAdvancedTab()	Helper to create an empty tab to use as the advanced tab
protected SimpleViewItemGroup	_createMainTab()	Helper to create an empty tab to use as the main tab
protected ModelItem	_getEntryModelItem(FormQuestion question)	Define the entry model items
protected List<ModelItem>	_getModelItems()	Get the list of ModelItems
protected SimpleViewItemGroup	_getRulesTab()	Get the view's common rules tab
protected abstract List<ViewItemGroup>	_getTabs(Form form)	Get the list of tabs that will be added in the question view.
void	configure(Configuration configuration)
void	doAdditionalOperations(FormQuestion question, Map<String,Object> values)	Do additional operations to create or edit the question
I18nizableText	getCategory()	Get the category of question type
I18nizableText	getDescription()	Get description of question type
Integer	getDisplayOrder()	Get display order of the question type
String	getDisplayXSLT()	Get the display XSLT file
Model	getEntryModel(FormQuestion question)	Get the form entry model for the question type
List<String>	getFieldToDisableIfFormPublished(FormQuestion question)	Get field to disable if form is published
String	getIconGlyph()	Get icon of question type button
String	getId()	Get id of the question type
I18nizableText	getLabel()	Get label of question type
Model	getModel()	Get the form question model
List<ClientSideElement.ScriptFile>	getScripts()	Get the scripts to import
View	getView(Form form)	Get the form question view
boolean	isQuestionConfigured(FormQuestion question)	Say if question needs more configuration to be used
void	saxAdditionalInfos(ContentHandler contentHandler, FormQuestion question)	Sax additional informations for the question type
void	saxEntryValue(ContentHandler contentHandler, FormQuestion question, FormEntry entry)	Sax the entry value depending on the question type
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
void	validateEntryValues(FormQuestion question, Map<String,Object> values, Multimap<String,I18nizableText> errors, Optional<Long> currentStepId)	Validate values to create a form entry
void	validateQuestionValues(Map<String,Object> values, Map<String,I18nizableText> errors)	Validate values to create or edit the question

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

Methods inherited from interface org.ametys.plugins.forms.question.FormQuestionType

canBeAnsweredByUser, getDefaultTitle, getJSConverter, getJSRenderer, getStorageType, isCacheable, onlyForDisplay, valueToJSONForClient

Field Details

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_id

protected String _id

Id of question type

_label

protected I18nizableText _label

Label of question type

_description

protected I18nizableText _description

Description of question type

_iconGlyph

protected String _iconGlyph

Icon glyph of question type

_pluginName

protected String _pluginName

Forms

_scripts

protected List<ClientSideElement.ScriptFile> _scripts

Scripts associated with question type

_xslt

protected String _xslt

Xslt associated of question type

_formQuestionModel

protected Model _formQuestionModel

The form question model

_category

protected I18nizableText _category

The type category in button menu

_priority

protected Integer _priority

The type priority in button menu

Constructor Details

AbstractStaticFormQuestionType

public AbstractStaticFormQuestionType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: FormQuestionType

Get id of the question type

Specified by:

getId in interface FormQuestionType

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: FormQuestionType

Get label of question type

Specified by:

getLabel in interface FormQuestionType

Returns:

the label

getDescription

public I18nizableText getDescription()

Description copied from interface: FormQuestionType

Get description of question type

Specified by:

getDescription in interface FormQuestionType

Returns:

the description

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: FormQuestionType

Get display order of the question type

Specified by:

getDisplayOrder in interface FormQuestionType

Returns:

the display order

getIconGlyph

public String getIconGlyph()

Description copied from interface: FormQuestionType

Get icon of question type button

Specified by:

getIconGlyph in interface FormQuestionType

Returns:

the icon-glyph name

getScripts

public List<ClientSideElement.ScriptFile> getScripts()

Description copied from interface: FormQuestionType

Get the scripts to import

Specified by:

getScripts in interface FormQuestionType

Returns:

the list of scripts

getDisplayXSLT

public String getDisplayXSLT()

Description copied from interface: FormQuestionType

Get the display XSLT file

Specified by:

getDisplayXSLT in interface FormQuestionType

Returns:

the display XSLT file

getCategory

public I18nizableText getCategory()

Description copied from interface: FormQuestionType

Get the category of question type

Specified by:

getCategory in interface FormQuestionType

Returns:

the name of the category in questionTypeButtonMenu

getModel

public Model getModel()

Description copied from interface: FormQuestionType

Get the form question model

Specified by:

getModel in interface FormQuestionType

Returns:

the form question model

getEntryModel

public Model getEntryModel(FormQuestion question)

Description copied from interface: FormQuestionType

Get the form entry model for the question type

Specified by:

getEntryModel in interface FormQuestionType

Parameters:

question - the question

Returns:

the form entry model

_getModelItems

protected List<ModelItem> _getModelItems()

Get the list of ModelItems

Returns:

a list of ModelItems

getView

public View getView(Form form)

Description copied from interface: FormQuestionType

Get the form question view

Specified by:

getView in interface FormQuestionType

Parameters:

form - the form

Returns:

a view of question model

_getTabs

protected abstract List<ViewItemGroup> _getTabs(Form form)

Get the list of tabs that will be added in the question view. The list returned by this method should include the tab provided by _getTabs

Parameters:

form - the form

Returns:

the tabs

_createMainTab

protected SimpleViewItemGroup _createMainTab()

Helper to create an empty tab to use as the main tab

Returns:

an empty tab

_createAdvancedTab

protected SimpleViewItemGroup _createAdvancedTab()

Helper to create an empty tab to use as the advanced tab

Returns:

an empty advanced tab

_getRulesTab

protected SimpleViewItemGroup _getRulesTab()

Get the view's common rules tab

Returns:

the rules tab as SimpleViewItemGroup

_getEntryModelItem

protected ModelItem _getEntryModelItem(FormQuestion question)

Define the entry model items

Parameters:

question - the question

Returns:

the entry model item

isQuestionConfigured

public boolean isQuestionConfigured(FormQuestion question)

Description copied from interface: FormQuestionType

Say if question needs more configuration to be used

Specified by:

isQuestionConfigured in interface FormQuestionType

Parameters:

question - the current question

Returns:

false if question needs more configuration, true by default

saxAdditionalInfos

public void saxAdditionalInfos(ContentHandler contentHandler,
 FormQuestion question)
                        throws SAXException

Description copied from interface: FormQuestionType

Sax additional informations for the question type

Specified by:

saxAdditionalInfos in interface FormQuestionType

Parameters:

contentHandler - the content handler

question - the question

Throws:

SAXException - if a saxing error occurred

doAdditionalOperations

public void doAdditionalOperations(FormQuestion question,
 Map<String,Object> values)

Description copied from interface: FormQuestionType

Do additional operations to create or edit the question

Specified by:

doAdditionalOperations in interface FormQuestionType

Parameters:

question - the question

values - the values

validateQuestionValues

public void validateQuestionValues(Map<String,Object> values,
 Map<String,I18nizableText> errors)

Description copied from interface: FormQuestionType

Validate values to create or edit the question

Specified by:

validateQuestionValues in interface FormQuestionType

Parameters:

values - the values

errors - the errors

validateEntryValues

public void validateEntryValues(FormQuestion question,
 Map<String,Object> values,
 Multimap<String,I18nizableText> errors,
 Optional<Long> currentStepId)

Description copied from interface: FormQuestionType

Validate values to create a form entry

Specified by:

validateEntryValues in interface FormQuestionType

Parameters:

question - the question

values - the values

errors - the errors

currentStepId - the current step id of the entry. Can be empty if the form has no workflow

saxEntryValue

public void saxEntryValue(ContentHandler contentHandler,
 FormQuestion question,
 FormEntry entry)
                   throws SAXException

Description copied from interface: FormQuestionType

Sax the entry value depending on the question type

Specified by:

saxEntryValue in interface FormQuestionType

Parameters:

contentHandler - the content handler

question - the question getting saxed

entry - the entry

Throws:

SAXException - exception while saxing entry

getFieldToDisableIfFormPublished

public List<String> getFieldToDisableIfFormPublished(FormQuestion question)

Description copied from interface: FormQuestionType

Get field to disable if form is published

Specified by:

getFieldToDisableIfFormPublished in interface FormQuestionType

Parameters:

question - the form question

Returns:

the list of field name