Interface Teaser

  • All Superinterfaces:
    Component, ComponentExporter

    public interface Teaser
    extends Component
    Defines the Teaser Sling Model for the /apps/core/wcm/components/teaser component.
    Since:
    com.adobe.cq.wcm.core.components.models 12.4.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NN_ACTIONS
      Name of the child node where the Call-to-Action elements are stored
      static java.lang.String PN_ACTION_LINK
      Name of the resource property that stores the Call-to-Action link
      static java.lang.String PN_ACTION_TEXT
      Name of the resource property that stores the Call-to-Action text
      static java.lang.String PN_ACTIONS_DISABLED
      Name of the policy property that defines whether or not Call-to-Actions are disabled
      static java.lang.String PN_ACTIONS_ENABLED
      Name of the resource property that defines whether or not the teaser has Call-to-Action elements
      static java.lang.String PN_DESCRIPTION_FROM_PAGE
      Name of the resource property that defines whether or not the description value is taken from the linked page.
      static java.lang.String PN_DESCRIPTION_HIDDEN
      Name of the policy property that defines whether or not the description is hidden.
      static java.lang.String PN_IMAGE_LINK_HIDDEN
      Name of the policy property that defines whether or not the image link is hidden.
      static java.lang.String PN_PRETITLE_HIDDEN
      Name of the policy property that defines whether or not the pretitle is hidden.
      static java.lang.String PN_TITLE_FROM_PAGE
      Name of the resource property that defines whether or not the title value is taken from the linked page.
      static java.lang.String PN_TITLE_HIDDEN
      Name of the policy property that defines whether or not the title is hidden.
      static java.lang.String PN_TITLE_LINK_HIDDEN
      Name of the policy property that defines whether or not the title link is hidden.
      static java.lang.String PN_TITLE_TYPE
      Name of the policy property that stores the value for this title's HTML element type.
      • 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 java.util.List<ListItem> getActions()
      Returns the list of Call-to-Action elements
      default java.lang.String getDescription()
      Returns this teaser's description, if one was defined.
      default @NotNull java.lang.String getExportedType()
      Returns the type of the resource for which the export is performed.
      default Resource getImageResource()
      Returns the image resource for this teaser.
      default java.lang.String getLinkURL()
      Returns the URL to which this teaser links, if one was defined.
      default java.lang.String getPretitle()
      Returns this teaser's pretitle, if one was defined.
      default java.lang.String getTitle()
      Returns this teaser's title, if one was defined.
      default java.lang.String getTitleType()
      Returns the HTML element type (h1-h6) used for the title.
      default boolean isActionsEnabled()
      Checks if the teaser has Call-to-Action elements
      default boolean isImageLinkHidden()
      Checks if the link on the image is hidden.
      default boolean isTitleLinkHidden()
      Checks if the link on the title is hidden.
    • Field Detail

      • PN_ACTIONS_ENABLED

        static final java.lang.String PN_ACTIONS_ENABLED
        Name of the resource property that defines whether or not the teaser has Call-to-Action elements
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • NN_ACTIONS

        static final java.lang.String NN_ACTIONS
        Name of the child node where the Call-to-Action elements are stored
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_ACTION_LINK

        static final java.lang.String PN_ACTION_LINK
        Name of the resource property that stores the Call-to-Action link
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_ACTION_TEXT

        static final java.lang.String PN_ACTION_TEXT
        Name of the resource property that stores the Call-to-Action text
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_ACTIONS_DISABLED

        static final java.lang.String PN_ACTIONS_DISABLED
        Name of the policy property that defines whether or not Call-to-Actions are disabled
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_IMAGE_LINK_HIDDEN

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

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

        static final java.lang.String PN_PRETITLE_HIDDEN
        Name of the policy property that defines whether or not the pretitle is hidden.
        Since:
        com.adobe.cq.wcm.core.components.models 12.12.0
        See Also:
        Constant Field Values
      • PN_TITLE_LINK_HIDDEN

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

        static final java.lang.String PN_TITLE_FROM_PAGE
        Name of the resource property that defines whether or not the title value is taken from the linked page.
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_DESCRIPTION_HIDDEN

        static final java.lang.String PN_DESCRIPTION_HIDDEN
        Name of the policy property that defines whether or not the description is hidden.
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_DESCRIPTION_FROM_PAGE

        static final java.lang.String PN_DESCRIPTION_FROM_PAGE
        Name of the resource property that defines whether or not the description value is taken from the linked page.
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        Constant Field Values
      • PN_TITLE_TYPE

        static final java.lang.String PN_TITLE_TYPE
        Name of the policy property that stores the value for this title's HTML element type.
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
        See Also:
        getTitleType(), Constant Field Values
    • Method Detail

      • isActionsEnabled

        default boolean isActionsEnabled()
        Checks if the teaser has Call-to-Action elements
        Returns:
        true if teaser has CTAs, false otherwise
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • getActions

        default java.util.List<ListItem> getActions()
        Returns the list of Call-to-Action elements
        Returns:
        the list of CTAs
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • getLinkURL

        default java.lang.String getLinkURL()
        Returns the URL to which this teaser links, if one was defined.
        Returns:
        the URL to which teaser links or null
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • getImageResource

        default Resource getImageResource()
        Returns the image resource for this teaser.
        Returns:
        the image resource for this teaser or null
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • isImageLinkHidden

        default boolean isImageLinkHidden()
        Checks if the link on the image is hidden.
        Returns:
        true if link is hidden on the image, false otherwise
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • getPretitle

        default java.lang.String getPretitle()
        Returns this teaser's pretitle, if one was defined.
        Returns:
        the teaser's pretitle or null
        Since:
        com.adobe.cq.wcm.core.components.models 12.12.0
      • getTitle

        default java.lang.String getTitle()
        Returns this teaser's title, if one was defined.
        Returns:
        the teaser's title or null
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • isTitleLinkHidden

        default boolean isTitleLinkHidden()
        Checks if the link on the title is hidden.
        Returns:
        true if link is hidden on the title, false otherwise
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • getDescription

        default java.lang.String getDescription()
        Returns this teaser's description, if one was defined.
        Returns:
        the teaser's description or null
        Since:
        com.adobe.cq.wcm.core.components.models 12.4.0
      • getTitleType

        default java.lang.String getTitleType()
        Returns the HTML element type (h1-h6) used for the title.
        Returns:
        the element type
        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.4.0
        See Also:
        ComponentExporter.getExportedType()