Interface Text
-
- All Superinterfaces:
Component,ComponentExporter
@ConsumerType public interface Text extends Component
Defines theTextSling Model used for the/apps/core/wcm/components/textcomponent.- 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.StringgetExportedType()Returns the type of the resource for which the export is performed.default java.lang.StringgetText()Retrieves the text value to be displayed.default booleanisRichText()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
nullif no value can be returned - Since:
- com.adobe.cq.wcm.core.components.models 11.0.0; marked
defaultin 12.1.0
-
isRichText
default boolean isRichText()
Checks if the text to be displayed is rich text or not.- Returns:
trueif the text is rich (HTML formatting),false otherwise- Since:
- com.adobe.cq.wcm.core.components.models 11.0.0; marked
defaultin 12.1.0
-
getExportedType
@NotNull default @NotNull java.lang.String getExportedType()
Description copied from interface:ComponentExporterReturns 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:
getExportedTypein interfaceComponent- Specified by:
getExportedTypein interfaceComponentExporter- Returns:
- the type of the component
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
ComponentExporter.getExportedType()
-
-