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

Interface Text

All Superinterfaces:

Component, ComponentExporter

@ConsumerType
public interface Text
extends Component

Defines the Text Sling Model used for the /apps/core/wcm/components/text component.

Since:

com.adobe.cq.wcm.core.components.models 11.0.0

Field Summary

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

PN_ID

Method Summary

Modifier and Type	Method and Description
default @NotNull String	getExportedType() Returns the type of the resource for which the export is performed.
default String	getText() Retrieves the text value to be displayed.
default boolean	isRichText() Checks if the text to be displayed is rich text or not.

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

getData, getId

Method Detail

getText

default String getText()

Retrieves the text value to be displayed.

Returns:

the text value to be displayed, or null if no value can be returned

Since:

com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

isRichText

default boolean isRichText()

Checks if the text to be displayed is rich text or not.

Returns:

true if the text is rich (HTML formatting), false otherwise

Since:

com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.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 Component

Specified by:

getExportedType in interface ComponentExporter

Returns:

the type of the component

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

See Also:

ComponentExporter.getExportedType()