Interface Text
-
- All Superinterfaces:
Component
,ComponentExporter
@ConsumerType public interface Text extends Component
Defines theText
Sling Model used for the/apps/core/wcm/components/text
component.- Since:
- com.adobe.cq.wcm.core.components.models 11.0.0
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default @NotNull java.lang.String
getExportedType()
Returns the type of the resource for which the export is performed.default java.lang.String
getText()
Retrieves the text value to be displayed.default boolean
isRichText()
Checks if the text to be displayed is rich text or not.
-
-
-
Method Detail
-
getText
default java.lang.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 java.lang.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 interfaceComponent
- Specified by:
getExportedType
in interfaceComponentExporter
- Returns:
- the type of the component
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
ComponentExporter.getExportedType()
-
-