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

Interface IllustrableFormQuestionType

All Known Implementing Classes:

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

public interface IllustrableFormQuestionType

Provide all the necessary method to add an illustration to a question type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_PICTURE	Constant for picture data attribute.
static final String	ATTRIBUTE_PICTURE_ALTERNATIVE	Constant for picture alternative attribute.

Method Summary

Modifier and Type	Method	Description
default File	getIllustration(FormQuestion question)	Get the question illustration
default String	getIllustrationAlternative(FormQuestion question)	Get the alternative of illustration
default List<ModelItem>	getIllustrationModelItems()	Provide a list of model items that must be included in the model items return by the method FormQuestionType.getModel
default SimpleViewItemGroup	getIllustrationTab(Model model)	Get the view's common illustration tab

Field Details

ATTRIBUTE_PICTURE

static final String ATTRIBUTE_PICTURE

Constant for picture data attribute.

See Also:

• Constant Field Values

ATTRIBUTE_PICTURE_ALTERNATIVE

static final String ATTRIBUTE_PICTURE_ALTERNATIVE

Constant for picture alternative attribute.

See Also:

• Constant Field Values

Method Details

getIllustrationModelItems

default List<ModelItem> getIllustrationModelItems()

Provide a list of model items that must be included in the model items return by the method FormQuestionType.getModel

Returns:

a list of model items

getIllustrationTab

default SimpleViewItemGroup getIllustrationTab(Model model)

Get the view's common illustration tab

Parameters:

model - the model of the question type

Returns:

the illustration tab as SimpleViewItemGroup

getIllustration

default File getIllustration(FormQuestion question)

Get the question illustration

Parameters:

question - the question

Returns:

the illustration

getIllustrationAlternative

default String getIllustrationAlternative(FormQuestion question)

Get the alternative of illustration

Parameters:

question - the question

Returns:

the alternative of illustration