Interface Teaser
-
- All Superinterfaces:
Component
,ComponentExporter
public interface Teaser extends Component
Defines theTeaser
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 String
NN_ACTIONS
Name of the child node where the Call-to-Action elements are storedstatic String
PN_ACTION_LINK
Name of the resource property that stores the Call-to-Action linkstatic String
PN_ACTION_TEXT
Name of the resource property that stores the Call-to-Action textstatic String
PN_ACTIONS_DISABLED
Name of the policy property that defines whether or not Call-to-Actions are disabledstatic String
PN_ACTIONS_ENABLED
Name of the resource property that defines whether or not the teaser has Call-to-Action elementsstatic 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 String
PN_DESCRIPTION_HIDDEN
Name of the policy property that defines whether or not the description is hidden.static String
PN_IMAGE_LINK_HIDDEN
Name of the policy property that defines whether or not the image link is hidden.static String
PN_PRETITLE_HIDDEN
Name of the policy property that defines whether or not the pretitle is hidden.static String
PN_SHOW_TITLE_TYPE
Name of the policy property that defines whether or not the title type is shown.static 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 String
PN_TITLE_HIDDEN
Name of the policy property that defines whether or not the title is hidden.static String
PN_TITLE_LINK_HIDDEN
Name of the policy property that defines whether or not the title link is hidden.static String
PN_TITLE_TYPE
Name of the policy property that stores the value for this title's HTML element type.
-
Method Summary
All Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default List<ListItem>
getActions()
Returns the list of Call-to-Action elementsdefault String
getDescription()
Returns this teaser's description, if one was defined.default Resource
getImageResource()
Returns the image resource for this teaser.default @Nullable com.adobe.cq.wcm.core.components.commons.link.Link
getLink()
Returns the primary link of this teaser.default String
getLinkURL()
Deprecated.Please usegetLink()
default String
getPretitle()
Returns this teaser's pretitle, if one was defined.default String
getTitle()
Returns this teaser's title, if one was defined.default String
getTitleType()
Returns the HTML element type (h1-h6) used for the title.default boolean
isActionsEnabled()
Checks if the teaser has Call-to-Action elementsdefault boolean
isImageLinkHidden()
Checks if the link on the image is hidden.default boolean
isTitleLinkHidden()
Checks if the link on the title is hidden.-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getExportedType, getId
-
-
-
-
Field Detail
-
PN_ACTIONS_ENABLED
static final 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 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 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 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 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 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 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 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 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 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 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 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 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
-
PN_SHOW_TITLE_TYPE
static final String PN_SHOW_TITLE_TYPE
Name of the policy property that defines whether or not the title type is shown.- Since:
- com.adobe.cq.wcm.core.components.models 12.16.0
- See Also:
- 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 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
-
getLink
@Nullable default @Nullable com.adobe.cq.wcm.core.components.commons.link.Link getLink()
Returns the primary link of this teaser.- Returns:
- the primary link of this teaser
- Since:
- com.adobe.cq.wcm.core.components.models 12.21.0
-
getLinkURL
@Deprecated default String getLinkURL()
Deprecated.Please usegetLink()
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 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 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 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 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
-
-