@Version("12.25.0")

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

This package defines the Sling Models exposed by the Adobe Experience Manager Core WCM Components Bundle.

Implementors of this API can choose which API level they support, by implementing all the methods up to a specified version of the API. All the provided interfaces document in which API version they were added. Furthermore, all methods also specify the API version in which they were introduced and deprecated.

All the interfaces from this package provide default methods that throw UnsupportedOperationExceptions. The reasoning behind this pattern is that implementors can upgrade the bundle without being forced to implement all the new methods provided by a newer API version, since the interfaces from this package are ConsumerTypes. An UnsupportedOperationException could be thrown when a component script would start using the newer API, without the actual implementation to support it. This can happen when an implementor migrates a proxy component to a newer version of the core component it proxies and a custom Sling Model implementation, supporting an older API version, is bound to this proxy component resource type.

Interface Summary

Interface	Description
Accordion	Defines the Accordion Sling Model used for the /apps/core/wcm/components/accordion component.
Breadcrumb	Defines the Breadcrumb Sling Model used for the /apps/core/wcm/components/breadcrumb component.
Button	Defines the Button Sling Model used for the /apps/core/wcm/components/button component.
Carousel	Defines the Carousel Sling Model used for the /apps/core/wcm/components/carousel component.
ClientLibraries	Defines the ClientLibraries Sling Model used to collect and include client libraries.
Component	A base interface to be extended by components that need to provide access to common properties.
ComponentFiles	This utility model allows looking up the paths of specific files from a collection of components, specified as Sling resource types.
Container	A base interface to be extended by containers such as the Carousel, Tabs and Accordion models.
Download	Defines the Download Sling Model used for the /apps/core/wcm/components/download component.
Embed	Defines the Embed Sling Model used for the /apps/core/wcm/components/embed component.
ExperienceFragment	Defines the ExperienceFragment Sling Model used for the /apps/core/wcm/components/experiencefragment component.
HtmlPageItem	This interface defines items that can be included on a page.
Image	Defines the Image Sling Model used for the /apps/core/wcm/components/image component.
ImageArea	Interface for an image map area, used by the Image model.
LanguageNavigation	Defines the LanguageNavigation Sling Model used for the /apps/core/wcm/components/languagenavigation component.
LanguageNavigationItem	Interface for a single language navigation item, used by the LanguageNavigation model.
LayoutContainer	Defines the LayoutContainer Sling Model used for the /apps/core/wcm/components/container component.
List	Defines the List Sling Model used for the /apps/core/wcm/components/list component.
ListItem	Interface for a generic list item, used by the List and Search models.
Navigation	Defines the Navigation Sling Model used for the /apps/core/wcm/components/navigation component.
NavigationItem	Interface for a single navigation item, used by the Breadcrumb and Navigation models.
Page	Defines the Page Sling Model used for the /apps/core/wcm/components/page component.
PdfViewer	Defines the PdfViewer component model.
ProgressBar
PWA	Interface for reading progressive web apps configuration
Search	Defines the Search Sling Model used for the /apps/core/wcm/components/search component.
Separator	Defines the Separator Sling Model used for the /apps/core/wcm/components/separator component.
SocialMediaHelper	Deprecated. The Social Media Sharing component is deprecated since Core Components 2.18.0 and should not be used in new projects.
TableOfContents
Tabs	Defines the Tabs Sling Model used for the /apps/core/wcm/components/tabs component.
Teaser	Defines the Teaser Sling Model for the /apps/core/wcm/components/teaser component.
Text	Defines the Text Sling Model used for the /apps/core/wcm/components/text component.
Title	Defines the Title Sling Model used for the /apps/core/wcm/components/title component.

Enum Summary

Enum	Description
Embed.Type	Enumeration of the supported embed input types.
HtmlPageItem.Element	enum that defines the possible HTML elements for a page item
HtmlPageItem.Location	enum that defines possible insert positions for a page item.
LayoutContainer.LayoutType	Enumeration of supported layout types for the container component
TableOfContents.HeadingLevel	Defines the possible heading levels for table of contents corresponding to 'h1' till 'h6'
TableOfContents.ListType	Defines the possible list types for table of contents