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

Interface DescriptibleFormQuestionType

All Known Implementing Classes:

AbstractFormQuestionType, CheckBoxQuestionType, ChoicesListQuestionType, DateTimeQuestionType, FileQuestionType, MatrixQuestionType, NumberQuestionType, SimpleTextQuestionType, TextAreaQuestionType

public interface DescriptibleFormQuestionType

Provide all the necessary method to add a description to a FormQuestionType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_DESCRIPTION	Constant for description attribute.

Method Summary

Modifier and Type	Method	Description
default String	getDescription(FormQuestion question)	Get the question description
default ModelItem	getDescriptionModelItem()	Get a model item to include in the model return by FormQuestionType.getModel
default ViewElement	getDescriptionViewElement(Model model)	Get a view element to include in the view returned by FormQuestionType.getView

Field Details

ATTRIBUTE_DESCRIPTION

static final String ATTRIBUTE_DESCRIPTION

Constant for description attribute.

See Also:

• Constant Field Values

Method Details

getDescriptionModelItem

default ModelItem getDescriptionModelItem()

Get a model item to include in the model return by FormQuestionType.getModel

Returns:

the item

getDescriptionViewElement

default ViewElement getDescriptionViewElement(Model model)

Get a view element to include in the view returned by FormQuestionType.getView

Parameters:

model - the question type model

Returns:

the element

getDescription

default String getDescription(FormQuestion question)

Get the question description

Parameters:

question - the question

Returns:

the description