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

Interface Title

  • All Superinterfaces:
    Component, ComponentExporter
    @ConsumerType
public interface Title
extends Component
    Defines the Title Sling Model used for the /apps/core/wcm/components/title component.
    Since:
    com.adobe.cq.wcm.core.components.models 11.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PN_DESIGN_DEFAULT_TYPE
      Name of the configuration policy property that will store the default value for this title's HTML element type.
      static java.lang.String PN_TITLE_LINK_DISABLED
      Name of the policy property that defines whether or not the title link is disabled.

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

        PN_ID

    • 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 getLinkURL()
      Returns the Title's link URL, if one was set.
      default java.lang.String getText()
      Returns the text to be displayed as title.
      default java.lang.String getType()
      Returns the HTML element type (h1-h6) used for the markup.
      default boolean isLinkDisabled()
      Checks if link is disabled on the title.

    • Field Detail

      • PN_DESIGN_DEFAULT_TYPE

        static final java.lang.String PN_DESIGN_DEFAULT_TYPE
        Name of the configuration policy property that will store the default value for this title's HTML element type.
        Since:
        com.adobe.cq.wcm.core.components.models 11.1.0
        See Also:
        getType(), Constant Field Values

      • PN_TITLE_LINK_DISABLED

        static final java.lang.String PN_TITLE_LINK_DISABLED
        Name of the policy property that defines whether or not the title link is disabled.
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values

    • Method Detail

      • getText

        default java.lang.String getText()
        Returns the text to be displayed as title.
        Returns:
        the title's text
        Since:
        com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

      • getType

        default java.lang.String getType()
        Returns the HTML element type (h1-h6) used for the markup.
        Returns:
        the element type
        Since:
        com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

      • getLinkURL

        default java.lang.String getLinkURL()
        Returns the Title's link URL, if one was set.
        Returns:
        the title's link URL, if one was set, or null
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0

      • isLinkDisabled

        default boolean isLinkDisabled()
        Checks if link is disabled on the title.
        Returns:
        true if link is disabled on the title, false otherwise
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.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 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()