Package com.adobe.cq.wcm.core.components.models.form

Interface Field

All Superinterfaces:

ComponentExporter

All Known Subinterfaces:

Button, Options, Text

@ConsumerType
public interface Field
extends ComponentExporter

A base interface to be extended by all the different types of form fields.

Since:

com.adobe.cq.wcm.core.components.models.form 13.0.0

Method Summary

Modifier and Type	Method	Description
default @NotNull String	getExportedType()	Returns the type of the resource for which the export is performed.
default String	getHelpMessage()	Returns the message for the help block.
default String	getId()	Returns an unique identifier for this field.
default String	getName()	Returns the value of the HTML name attribute.
default String	getTitle()	Returns the title of the field (text displayed on the field).
default String	getValue()	Returns the value of the HTML value attribute.

Method Detail

getId

default String getId()

Returns an unique identifier for this field.

Returns:

an unique identifier for the field

Since:

com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

getName

default String getName()

Returns the value of the HTML name attribute.

Returns:

the value of the HTML name attribute

Note: {'name':'value'} is sent as a request parameter when POST-ing the form

Since:

com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

getValue

default String getValue()

Returns the value of the HTML value attribute.

Returns:

the value of the HTML value attribute

Note: {'name':'value'} is sent as a request parameter when POST-ing the form

Since:

com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

getTitle

default String getTitle()

Returns the title of the field (text displayed on the field).

Returns:

the title of the field (text displayed on the field)

Implementations can return null if the title is not required.

Since:

com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

getHelpMessage

default String getHelpMessage()

Returns the message for the help block.

Returns:

the message for the help block

Implementations can return null if the help message is not required.

Since:

com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

getExportedType

@NotNull
default @NotNull String getExportedType()

Description copied from interface: ComponentExporter

Returns the type of the resource for which the export is performed.

NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.

Specified by:

getExportedType in interface ComponentExporter

Returns:

the type of the component

Since:

com.adobe.cq.wcm.core.components.models.form 14.2.0

See Also:

ComponentExporter.getExportedType()