Package io.micronaut.views.fields.render

Interface FormElementRenderer<T extends FormElement>

Type Parameters:

T - Form element

All Known Implementing Classes:

InputCheckboxFormElementRenderer, InputCheckboxViewsFormElementRenderer, InputDateFormElementRenderer, InputDateTimeLocalFormElementRenderer, InputDateTimeLocalViewsFormElementRenderer, InputDateViewsFormElementRenderer, InputEmailFormElementRenderer, InputEmailViewsFormElementRenderer, InputHiddenFormElementRenderer, InputHiddenViewsFormElementRenderer, InputNumberFormElementRenderer, InputNumberViewsFormElementRenderer, InputPasswordFormElementRenderer, InputPasswordViewsFormElementRenderer, InputRadioFormElementRenderer, InputRadioViewsFormElementRenderer, InputSubmitFormElementRenderer, InputSubmitViewsFormElementRenderer, InputTelFormElementRenderer, InputTelViewsFormElementRenderer, InputTextFormElementRenderer, InputTextViewsFormElementRenderer, InputTimeFormElementRenderer, InputTimeViewsFormElementRenderer, InputUrlFormElementRenderer, InputUrlViewsFormElementRenderer, OptionFormElementRenderer, OptionViewsFormElementRenderer, SelectFormElementRenderer, SelectViewsFormElementRenderer, TextareaFormElementRenderer, TextareaViewsFormElementRenderer, TrixEditorFormElementRenderer, TrixEditorViewsFormElementRenderer, ViewsFormElementRenderer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface FormElementRenderer<T extends FormElement>

API to render a FormElement.

Since:

4.1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_CHECKED	HTML Attribute checked.
static final String	ATTR_COLS	HTML Attribute cols.
static final String	ATTR_DISABLED	HTML Attribute disabled.
static final String	ATTR_FOR	HTML Attribute for.
static final String	ATTR_ID	HTML Attribute id.
static final String	ATTR_MAX	HTML Attribute max.
static final String	ATTR_MAX_LENGTH	HTML Attribute maxlength.
static final String	ATTR_MIN	HTML Attribute min.
static final String	ATTR_MIN_LENGTH	HTML Attribute minlength.
static final String	ATTR_NAME	HTML Attribute name.
static final String	ATTR_PATTERN	HTML Attribute pattern.
static final String	ATTR_PLACEHOLDER	HTML Attribute placeholder.
static final String	ATTR_READ_ONLY	HTML Attribute readonly.
static final String	ATTR_REQUIRED	HTML Attribute required.
static final String	ATTR_ROWS	HTML Attribute rows.
static final String	ATTR_SELECTED	HTML Attribute selected.
static final String	ATTR_SIZE	HTML Attribute size.
static final String	ATTR_STEP	HTML Attribute step.
static final String	ATTR_TYPE	HTML Attribute type.
static final String	ATTR_VALUE	HTML Attribute value.
static final String	GREATER_THAN	Greater than sign.
static final String	LESS_THAN	Lower than sign.
static final String	SLASH	Slash.
static final String	SPACE	Space.

Method Summary

Modifier and Type	Method	Description
default @NonNull List<HtmlAttribute>	attributes(@NonNull InputStringFormElement el, @NonNull InputType type)
default String	content(@NonNull Message message, @NonNull io.micronaut.context.MessageSource messageSource, @NonNull Locale locale)
@NonNull String	render(@NonNull T formElement, @NonNull Locale locale)	Renders a Form Element as HTML.
default @NonNull String	render(@NonNull HtmlTag tag, @NonNull List<HtmlAttribute> attributes)	Renders an HTML Tag.
default @NonNull String	render(@NonNull HtmlTag tag, @NonNull List<HtmlAttribute> attributes, @NonNull String content)	Renders an HTML Tag.
default String	renderCloseTag(@NonNull HtmlTag tag)
default String	renderLabel(@Nullable String id, @NonNull Message message, @NonNull io.micronaut.context.MessageSource messageSource, @NonNull Locale locale)
default String	renderOpenTag(@NonNull HtmlTag tag, @NonNull List<HtmlAttribute> attributes)
default HtmlAttribute	typeHtmlAttribute(@NonNull InputType type)

Field Details

ATTR_FOR

static final String ATTR_FOR

HTML Attribute for.

See Also:

• Constant Field Values

ATTR_VALUE

static final String ATTR_VALUE

HTML Attribute value.

See Also:

• Constant Field Values

ATTR_SELECTED

static final String ATTR_SELECTED

HTML Attribute selected.

See Also:

• Constant Field Values

ATTR_DISABLED

static final String ATTR_DISABLED

HTML Attribute disabled.

See Also:

• Constant Field Values

ATTR_ID

static final String ATTR_ID

HTML Attribute id.

See Also:

• Constant Field Values

ATTR_ROWS

static final String ATTR_ROWS

HTML Attribute rows.

See Also:

• Constant Field Values

ATTR_COLS

static final String ATTR_COLS

HTML Attribute cols.

See Also:

• Constant Field Values

ATTR_PLACEHOLDER

static final String ATTR_PLACEHOLDER

HTML Attribute placeholder.

See Also:

• Constant Field Values

ATTR_STEP

static final String ATTR_STEP

HTML Attribute step.

See Also:

• Constant Field Values

ATTR_REQUIRED

static final String ATTR_REQUIRED

HTML Attribute required.

See Also:

• Constant Field Values

ATTR_READ_ONLY

static final String ATTR_READ_ONLY

HTML Attribute readonly.

See Also:

• Constant Field Values

ATTR_MAX_LENGTH

static final String ATTR_MAX_LENGTH

HTML Attribute maxlength.

See Also:

• Constant Field Values

ATTR_MIN_LENGTH

static final String ATTR_MIN_LENGTH

HTML Attribute minlength.

See Also:

• Constant Field Values

ATTR_MAX

static final String ATTR_MAX

HTML Attribute max.

See Also:

• Constant Field Values

ATTR_MIN

static final String ATTR_MIN

HTML Attribute min.

See Also:

• Constant Field Values

ATTR_PATTERN

static final String ATTR_PATTERN

HTML Attribute pattern.

See Also:

• Constant Field Values

ATTR_SIZE

static final String ATTR_SIZE

HTML Attribute size.

See Also:

• Constant Field Values

ATTR_NAME

static final String ATTR_NAME

HTML Attribute name.

See Also:

• Constant Field Values

ATTR_CHECKED

static final String ATTR_CHECKED

HTML Attribute checked.

See Also:

• Constant Field Values

ATTR_TYPE

static final String ATTR_TYPE

HTML Attribute type.

See Also:

• Constant Field Values

LESS_THAN

static final String LESS_THAN

Lower than sign.

See Also:

• Constant Field Values

GREATER_THAN

static final String GREATER_THAN

Greater than sign.

See Also:

• Constant Field Values

SLASH

static final String SLASH

Slash.

See Also:

• Constant Field Values

SPACE

static final String SPACE

Space.

See Also:

• Constant Field Values

Method Details

render

@NonNull String render(@NonNull T formElement,
 @NonNull Locale locale)

Renders a Form Element as HTML.

Parameters:

formElement - Form Element

locale - Locale

Returns:

HTML

render

default @NonNull String render(@NonNull HtmlTag tag,
 @NonNull List<HtmlAttribute> attributes)

Renders an HTML Tag.

Parameters:

tag - HTML Tag

attributes - HTML attributes

Returns:

HTML

render

default @NonNull String render(@NonNull HtmlTag tag,
 @NonNull List<HtmlAttribute> attributes,
 @NonNull String content)

Renders an HTML Tag.

Parameters:

tag - HTML Tag

attributes - HTML attributes

content - Content

Returns:

HTML

renderLabel

default String renderLabel(@Nullable String id,
 @NonNull Message message,
 @NonNull io.micronaut.context.MessageSource messageSource,
 @NonNull Locale locale)

Parameters:

id - element id referenced by the label

message - Message

messageSource - Message Source

locale - Locale

Returns:

localized content

renderOpenTag

default String renderOpenTag(@NonNull HtmlTag tag,
 @NonNull List<HtmlAttribute> attributes)

Parameters:

tag - an HTML Tag

attributes - HTML Attributes

Returns:

HTML

renderCloseTag

default String renderCloseTag(@NonNull HtmlTag tag)

Parameters:

tag - an HTML Tag

Returns:

HTML

content

default String content(@NonNull Message message,
 @NonNull io.micronaut.context.MessageSource messageSource,
 @NonNull Locale locale)

Parameters:

message - Message

messageSource - Message Source

locale - Locale

Returns:

localized content

typeHtmlAttribute

default HtmlAttribute typeHtmlAttribute(@NonNull InputType type)

Parameters:

type - Input type

Returns:

An HTML attribute with key type and value the parameter

attributes

default @NonNull List<HtmlAttribute> attributes(@NonNull InputStringFormElement el,
 @NonNull InputType type)

Parameters:

el - InputStringFormElement

type - input type

Returns:

HTML Attributes