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

Class ChoicesListQuestionType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.forms.question.types.AbstractFormQuestionType

org.ametys.plugins.forms.question.types.ChoicesListQuestionType

All Implemented Interfaces:

FormQuestionType, ConfidentialAwareQuestionType, DescriptibleFormQuestionType, IllustrableFormQuestionType, MandatoryAwareFormQuestionType, MultipleAwareFormQuestionType, RestrictiveQuestionType, LogEnabled, PluginAware, Configurable, Serviceable

public class ChoicesListQuestionType
extends AbstractFormQuestionType
implements MultipleAwareFormQuestionType

Class for creating choices list questions

Field Summary

Fields

Modifier and Type	Field	Description
protected ChoiceSourceTypeExtensionPoint	_choiceSourceTypeExtensionPoint	The choice source type extension point
static final String	ATTRIBUTE_FORMAT	Constant for the format attribute
static final String	ATTRIBUTE_OTHER	Constant for other option attribute
static final String	ATTRIBUTE_PLACEHOLDER	Constant for placeholder attribute.
static final String	ATTRIBUTE_SOURCE_TYPE	Constant for source type attribute
static final String	CHECKBOX_FORMAT_VALUE	Name of checkbox formatStaticEnumerator entry
static final String	COMBOBOXBOX_FORMAT_VALUE	Name of combobox formatStaticEnumerator entry
static final String	DEFAULT_TITLE	Constant for default title
static final String	DEFAULT_TYPE_ID	Id of the default type for formatStaticEnumerator
static final String	OTHER_OPTION_VALUE	Label of the other option value
static final String	OTHER_PREFIX_DATA_NAME	Label of the other option value

Fields inherited from class org.ametys.plugins.forms.question.types.AbstractFormQuestionType

_workflowHelper

Fields inherited from class org.ametys.plugins.forms.question.types.AbstractStaticFormQuestionType

_category, _description, _formQuestionModel, _i18nUtils, _iconGlyph, _id, _label, _pluginName, _priority, _scripts, _xslt

Fields inherited from interface org.ametys.plugins.forms.question.types.ConfidentialAwareQuestionType

ATTRIBUTE_CONFIDENTIALITY

Fields inherited from interface org.ametys.plugins.forms.question.types.DescriptibleFormQuestionType

ATTRIBUTE_DESCRIPTION

Fields inherited from interface org.ametys.plugins.forms.question.types.IllustrableFormQuestionType

ATTRIBUTE_PICTURE, ATTRIBUTE_PICTURE_ALTERNATIVE

Fields inherited from interface org.ametys.plugins.forms.question.types.MandatoryAwareFormQuestionType

ATTRIBUTE_MANDATORY

Fields inherited from interface org.ametys.plugins.forms.question.types.MultipleAwareFormQuestionType

ATTRIBUTE_MULTIPLE

Fields inherited from interface org.ametys.plugins.forms.question.types.RestrictiveQuestionType

ATTRIBUTE_READING, ATTRIBUTE_READING_CHECKBOX, ATTRIBUTE_WRITING, ATTRIBUTE_WRITING_CHECKBOX, INITIAL_WORKFLOW_ID

Constructor Summary

Constructors

Constructor	Description
ChoicesListQuestionType()

Method Summary

Modifier and Type	Method	Description
protected SimpleViewItemGroup	_getAdvancedTab()	Define the content of the advanced tab
protected ModelItem	_getEntryModelItem(FormQuestion question)	Define the entry model items
protected SimpleViewItemGroup	_getMainTab()	Define the content of the main tab
protected List<ModelItem>	_getModelItems()	Get the list of ModelItems
void	doAdditionalOperations(FormQuestion question, Map<String,Object> values)	Do additional operations to create or edit the question
I18nizableText	getDefaultTitle()	Get the default title depending on type
List<String>	getFieldToDisableIfFormPublished(FormQuestion question)	Get field to disable if form is published
String	getJSConverter(FormQuestion question)	Get the js converter for the choice list
String	getJSRenderer(FormQuestion question)	Get the js renderer for the choice list
Validator	getMandatoryValidator(FormQuestion question)	Create a validator that should be added to the element definition return by FormQuestionType.getEntryModel
Map<String,I18nizableText>	getOptions(FormQuestion question)	Get options of the choices list
ModelItem	getOtherFieldModel(FormQuestion question)	Get other field model
ChoiceSourceType	getSourceType(FormQuestion question)	Get type of source for this question
String	getStorageType(FormQuestion question)	Get the storage type of the question type
boolean	hasOtherOption(FormQuestion question)	true if the choice list can have an other value
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	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
Object	valueToJSONForClient(Object value, FormQuestion question, FormEntry entry, ModelItem modelItem)	Convert the entry value into a JSON object to use client side

Methods inherited from class org.ametys.plugins.forms.question.types.AbstractFormQuestionType

_getTabs, getWorkflowDescriptor

Methods inherited from class org.ametys.plugins.forms.question.types.AbstractStaticFormQuestionType

_createAdvancedTab, _createMainTab, _getRulesTab, configure, getCategory, getDescription, getDisplayOrder, getDisplayXSLT, getEntryModel, getIconGlyph, getId, getLabel, getModel, getScripts, getView, setPluginInfo

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.types.ConfidentialAwareQuestionType

getConfidentialityModelItem, getConfidentialityViewElement

Methods inherited from interface org.ametys.plugins.forms.question.types.DescriptibleFormQuestionType

getDescription, getDescriptionModelItem, getDescriptionViewElement

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

canBeAnsweredByUser, isCacheable, onlyForDisplay

Methods inherited from interface org.ametys.plugins.forms.question.types.IllustrableFormQuestionType

getIllustration, getIllustrationAlternative, getIllustrationModelItems, getIllustrationTab

Methods inherited from interface org.ametys.plugins.forms.question.types.MandatoryAwareFormQuestionType

getMandatoryModelItem, getMandatoryViewElement, isMandatory

Methods inherited from interface org.ametys.plugins.forms.question.types.MultipleAwareFormQuestionType

getMultipleModelItem, getMultipleViewElement, isMultiple

Methods inherited from interface org.ametys.plugins.forms.question.types.RestrictiveQuestionType

getReadingSteps, getRestrictiveModelItems, getRestrictiveTab, getWritingSteps, isModifiable, isReadRestricted

Field Details

ATTRIBUTE_SOURCE_TYPE

public static final String ATTRIBUTE_SOURCE_TYPE

Constant for source type attribute

See Also:

• Constant Field Values

ATTRIBUTE_OTHER

public static final String ATTRIBUTE_OTHER

Constant for other option attribute

See Also:

• Constant Field Values

ATTRIBUTE_FORMAT

public static final String ATTRIBUTE_FORMAT

Constant for the format attribute

See Also:

• Constant Field Values

ATTRIBUTE_PLACEHOLDER

public static final String ATTRIBUTE_PLACEHOLDER

Constant for placeholder attribute.

See Also:

• Constant Field Values

DEFAULT_TYPE_ID

public static final String DEFAULT_TYPE_ID

Id of the default type for formatStaticEnumerator

See Also:

• Constant Field Values

CHECKBOX_FORMAT_VALUE

public static final String CHECKBOX_FORMAT_VALUE

Name of checkbox formatStaticEnumerator entry

See Also:

• Constant Field Values

COMBOBOXBOX_FORMAT_VALUE

public static final String COMBOBOXBOX_FORMAT_VALUE

Name of combobox formatStaticEnumerator entry

See Also:

• Constant Field Values

OTHER_OPTION_VALUE

public static final String OTHER_OPTION_VALUE

Label of the other option value

See Also:

• Constant Field Values

OTHER_PREFIX_DATA_NAME

public static final String OTHER_PREFIX_DATA_NAME

Label of the other option value

See Also:

• Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE

Constant for default title

See Also:

• Constant Field Values

_choiceSourceTypeExtensionPoint

protected ChoiceSourceTypeExtensionPoint _choiceSourceTypeExtensionPoint

The choice source type extension point

Constructor Details

ChoicesListQuestionType

public ChoicesListQuestionType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractFormQuestionType

Throws:

ServiceException

_getModelItems

protected List<ModelItem> _getModelItems()

Description copied from class: AbstractStaticFormQuestionType

Get the list of ModelItems

Overrides:

_getModelItems in class AbstractFormQuestionType

Returns:

a list of ModelItems

_getMainTab

protected SimpleViewItemGroup _getMainTab()

Description copied from class: AbstractFormQuestionType

Define the content of the main tab

Overrides:

_getMainTab in class AbstractFormQuestionType

Returns:

the main tab definition

_getAdvancedTab

protected SimpleViewItemGroup _getAdvancedTab()

Description copied from class: AbstractFormQuestionType

Define the content of the advanced tab

Overrides:

_getAdvancedTab in class AbstractFormQuestionType

Returns:

the advanced tab definition

getOptions

public Map<String,I18nizableText> getOptions(FormQuestion question)

Get options of the choices list

Parameters:

question - The current question

Returns:

a map of the options: key is optionValue, value is optionLabel

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

Overrides:

saxAdditionalInfos in class AbstractStaticFormQuestionType

Parameters:

contentHandler - the content handler

question - the question

Throws:

SAXException - if a saxing error occurred

getStorageType

public String getStorageType(FormQuestion question)

Description copied from interface: FormQuestionType

Get the storage type of the question type

Specified by:

getStorageType in interface FormQuestionType

Parameters:

question - the question

Returns:

the storage type

_getEntryModelItem

protected ModelItem _getEntryModelItem(FormQuestion question)

Description copied from class: AbstractStaticFormQuestionType

Define the entry model items

Overrides:

_getEntryModelItem in class AbstractFormQuestionType

Parameters:

question - the question

Returns:

the entry model item

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

Overrides:

doAdditionalOperations in class AbstractStaticFormQuestionType

Parameters:

question - the question

values - the values

getDefaultTitle

public I18nizableText getDefaultTitle()

Description copied from interface: FormQuestionType

Get the default title depending on type

Specified by:

getDefaultTitle in interface FormQuestionType

Returns:

the default title

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

Overrides:

isQuestionConfigured in class AbstractStaticFormQuestionType

Parameters:

question - the current question

Returns:

false if question needs more configuration, true by default

getSourceType

public ChoiceSourceType getSourceType(FormQuestion question)

Get type of source for this question

Parameters:

question - the current question

Returns:

the ChoiceSourceType

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

Overrides:

saxEntryValue in class AbstractStaticFormQuestionType

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

Overrides:

getFieldToDisableIfFormPublished in class AbstractFormQuestionType

Parameters:

question - the form question

Returns:

the list of field name

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

Overrides:

validateQuestionValues in class AbstractStaticFormQuestionType

Parameters:

values - the values

errors - the errors

getMandatoryValidator

public Validator getMandatoryValidator(FormQuestion question)

Description copied from interface: MandatoryAwareFormQuestionType

Create a validator that should be added to the element definition return by FormQuestionType.getEntryModel

Specified by:

getMandatoryValidator in interface MandatoryAwareFormQuestionType

Parameters:

question - the question

Returns:

a validator

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

Overrides:

validateEntryValues in class AbstractStaticFormQuestionType

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

getOtherFieldModel

public ModelItem getOtherFieldModel(FormQuestion question)

Get other field model

Parameters:

question - the question

Returns:

the other field model

hasOtherOption

public boolean hasOtherOption(FormQuestion question)

true if the choice list can have an other value

Parameters:

question - the question

Returns:

true if the choice list can have an other value

getJSRenderer

public String getJSRenderer(FormQuestion question)

Description copied from interface: FormQuestionType

Get the js renderer for the choice list

Specified by:

getJSRenderer in interface FormQuestionType

Parameters:

question - the question

Returns:

the js renderer

getJSConverter

public String getJSConverter(FormQuestion question)

Description copied from interface: FormQuestionType

Get the js converter for the choice list

Specified by:

getJSConverter in interface FormQuestionType

Parameters:

question - the question

Returns:

the js converter

valueToJSONForClient

public Object valueToJSONForClient(Object value,
 FormQuestion question,
 FormEntry entry,
 ModelItem modelItem)
                            throws Exception

Description copied from interface: FormQuestionType

Convert the entry value into a JSON object to use client side

Specified by:

valueToJSONForClient in interface FormQuestionType

Parameters:

value - the value to convert

question - the form question

entry - the form entry

modelItem - the model item

Returns:

The value as JSON

Throws:

Exception - if an error occurred