Skip navigation links
A B C D E F G H I J L M N O P R S T U V W Y 

A

AbstractComponentImpl - Class in com.adobe.cq.wcm.core.components.util
Abstract class that can be used as a base class for Component implementations.
AbstractComponentImpl() - Constructor for class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
 
accepts(String, SlingHttpServletRequest) - Method in interface com.adobe.cq.wcm.core.components.services.link.PathProcessor
Checks if the given path should be handled by this processor.
Accordion - Interface in com.adobe.cq.wcm.core.components.models
Defines the Accordion Sling Model used for the /apps/core/wcm/components/accordion component.
asComponent() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataLayerExtender
Get a ComponentDataBuilder that extends existing component data.
asContainer() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataLayerExtender
Get a ContainerDataBuilder that extends existing component data.
asContentFragment() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataLayerExtender
Get a ContentFragmentDataBuilder that extends existing component data.
asEmbeddable() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataLayerExtender
Gets a EmbeddableDataBuilder that extends existing component data.
asImageComponent() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataLayerExtender
Get a ImageComponentDataBuilder that extends existing component data.
asPage() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataLayerExtender
Get a PageDataBuilder that extends existing component data.
AssetData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
Interface defining data for assets.
AssetDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data builder for a Dam Assets.
AttributeConfig - Annotation Type in com.adobe.cq.wcm.core.components.config
 

B

Breadcrumb - Interface in com.adobe.cq.wcm.core.components.models
Defines the Breadcrumb Sling Model used for the /apps/core/wcm/components/breadcrumb component.
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
 
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ComponentDataBuilder
 
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ContainerDataBuilder
 
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ContentFragmentDataBuilder
 
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.EmbeddableDataBuilder
 
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.GenericDataBuilder
Build the data.
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ImageComponentDataBuilder
 
build() - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.PageDataBuilder
 
Button - Interface in com.adobe.cq.wcm.core.components.models
Defines the Button Sling Model used for the /apps/core/wcm/components/button component.
Button - Interface in com.adobe.cq.wcm.core.components.models.form
Defines the Button Sling Model used for the /apps/core/wcm/components/button component.
Button.Type - Enum in com.adobe.cq.wcm.core.components.models.form
Defines button type.

C

Carousel - Interface in com.adobe.cq.wcm.core.components.models
Defines the Carousel Sling Model used for the /apps/core/wcm/components/carousel component.
ClientLibraries - Interface in com.adobe.cq.wcm.core.components.models
Defines the ClientLibraries Sling Model used to collect and include client libraries.
com.adobe.cq.wcm.core.components.commons.editor.dialog - package com.adobe.cq.wcm.core.components.commons.editor.dialog
This package defines the Sling Models exposed for the dialog widgets.
com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor - package com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor
This package defines the Sling Models exposed for the childreneditor component.
com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited - package com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited
This package defines the Sling Models exposed for the inherited component.
com.adobe.cq.wcm.core.components.commons.link - package com.adobe.cq.wcm.core.components.commons.link
Link handling.
com.adobe.cq.wcm.core.components.config - package com.adobe.cq.wcm.core.components.config
This package defines the context-aware configurations used by the WCM Core Components
com.adobe.cq.wcm.core.components.models - package com.adobe.cq.wcm.core.components.models
This package defines the Sling Models exposed by the Adobe Experience Manager Core WCM Components Bundle.
com.adobe.cq.wcm.core.components.models.contentfragment - package com.adobe.cq.wcm.core.components.models.contentfragment
 
com.adobe.cq.wcm.core.components.models.datalayer - package com.adobe.cq.wcm.core.components.models.datalayer
This packages defines models for integration with Adobe Client Data Layer
com.adobe.cq.wcm.core.components.models.datalayer.builder - package com.adobe.cq.wcm.core.components.models.datalayer.builder
This packages defines a helper utility for building data layer models for integration with Adobe Client Data Layer.
com.adobe.cq.wcm.core.components.models.datalayer.jackson - package com.adobe.cq.wcm.core.components.models.datalayer.jackson
This packages provides a jackson specific serializer for component data which is used by the Adobe Client Data Layer.
com.adobe.cq.wcm.core.components.models.embeddable - package com.adobe.cq.wcm.core.components.models.embeddable
 
com.adobe.cq.wcm.core.components.models.form - package com.adobe.cq.wcm.core.components.models.form
This package defines the Sling Models exposed by the Adobe Experience Manager Core WCM Components Bundle for the form components.
com.adobe.cq.wcm.core.components.services.embed - package com.adobe.cq.wcm.core.components.services.embed
 
com.adobe.cq.wcm.core.components.services.form - package com.adobe.cq.wcm.core.components.services.form
 
com.adobe.cq.wcm.core.components.services.link - package com.adobe.cq.wcm.core.components.services.link
 
com.adobe.cq.wcm.core.components.util - package com.adobe.cq.wcm.core.components.util
This package defines utility classes exposed by the Adobe Experience Manager Core WCM Components Bundle.
Component - Interface in com.adobe.cq.wcm.core.components.models
A base interface to be extended by components that need to provide access to common properties.
component - Variable in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
The component.
componentContext - Variable in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
The component context.
ComponentData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
A base interface to be extended by components that need to enable data layer integration.
ComponentDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data builder for components that are not a specific type of component.
ComponentDataLayerExtender - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Component data layer extender.
ComponentDataModelSerializer - Class in com.adobe.cq.wcm.core.components.models.datalayer.jackson
 
ComponentDataModelSerializer() - Constructor for class com.adobe.cq.wcm.core.components.models.datalayer.jackson.ComponentDataModelSerializer
 
ComponentDataModelSerializer(Class<ComponentData>) - Constructor for class com.adobe.cq.wcm.core.components.models.datalayer.jackson.ComponentDataModelSerializer
 
ComponentFiles - Interface in com.adobe.cq.wcm.core.components.models
This utility model allows looking up the paths of specific files from a collection of components, specified as Sling resource types.
ComponentUtils - Class in com.adobe.cq.wcm.core.components.util
Utility helper functions for components.
Container - Interface in com.adobe.cq.wcm.core.components.models
A base interface to be extended by containers such as the Carousel, Tabs and Accordion models.
Container - Interface in com.adobe.cq.wcm.core.components.models.form
Defines the form Container Sling Model used for the /apps/core/wcm/components/form/container component.
ContainerData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
Interface defining data for container components.
ContainerDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data builder for container components.
ContentFragment - Interface in com.adobe.cq.wcm.core.components.models.contentfragment
Defines the Sling model for the /apps/core/wcm/components/contentfragment component.
ContentFragmentData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
 
ContentFragmentData.ElementData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
 
ContentFragmentDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data builder for content fragment components.
ContentFragmentList - Interface in com.adobe.cq.wcm.core.components.models.contentfragment
Defines a Sling model used for the /apps/core/wcm/components/contentfragmentlist component.
CSS_BORDERLESS - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
 
CSS_FULL_WINDOW - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
 
CSS_IN_LINE - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
 
CSS_SIZED_CONTAINER - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
 

D

DAMContentFragment - Interface in com.adobe.cq.wcm.core.components.models.contentfragment
Defines the API for a DAM content fragment used by the content fragment component and the content fragment list component.
DAMContentFragment.DAMContentElement - Interface in com.adobe.cq.wcm.core.components.models.contentfragment
Represents a content element of a content fragment.
DataLayerBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data layer builder utility.
DataLayerSupplier - Interface in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data layer field value supplier.
displayFilename() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Checks if the filename should be displayed.
displayFormat() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Checks if the file format should be displayed.
displayItemAsTeaser() - Method in interface com.adobe.cq.wcm.core.components.models.List
Returns true if the list's items should be displayed as teasers.
displayPopupTitle() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Checks if the image should display its caption as a popup (through the <img> title attribute).
displaySize() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Checks if the file size should be displayed.
Download - Interface in com.adobe.cq.wcm.core.components.models
Defines the Download Sling Model used for the /apps/core/wcm/components/download component.

E

Editor - Class in com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor
Defines an Editor Sling Model used by the /apps/core/wcm/components/commons/editor/dialog/childreneditor/v1/childreneditor dialog component.
Editor() - Constructor for class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Editor
 
Embed - Interface in com.adobe.cq.wcm.core.components.models
Defines the Embed Sling Model used for the /apps/core/wcm/components/embed component.
Embed.Type - Enum in com.adobe.cq.wcm.core.components.models
Enumeration of the supported embed input types.
Embeddable - Interface in com.adobe.cq.wcm.core.components.models.embeddable
A base interface to be extended by embeddable
EmbeddableData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
Interface defining data for embeddables.
EmbeddableDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data builder for an Embeddable.
EmbeddableDataBuilder(DataLayerSupplier) - Constructor for class com.adobe.cq.wcm.core.components.models.datalayer.builder.EmbeddableDataBuilder
 
EMPTY_SUPPLIER - Static variable in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
An empty DataLayerSupplier which has null values for all field value suppliers.
ExperienceFragment - Interface in com.adobe.cq.wcm.core.components.models
Defines the ExperienceFragment Sling Model used for the /apps/core/wcm/components/experiencefragment component.
extending(AssetData) - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get a AssetDataBuilder that extends existing asset data.
extending(ComponentData) - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Extend an existing component data layer model.
externalize(String, SlingHttpServletRequest) - Method in interface com.adobe.cq.wcm.core.components.services.link.PathProcessor
Externalizes the given path.

F

Field - Interface in com.adobe.cq.wcm.core.components.models.form
A base interface to be extended by all the different types of form fields.
FN_FAVICON_ICO - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Expected file name for the regular favicon file.
FN_FAVICON_PNG - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Expected file name for the PNG-format favicon file.
FN_TOUCH_ICON_120 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Expected file name for the touch 120px square favicon file.
FN_TOUCH_ICON_152 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Expected file name for the touch 152px square favicon file.
FN_TOUCH_ICON_60 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Expected file name for the touch 60px square favicon file.
FN_TOUCH_ICON_76 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Expected file name for the touch 76px square favicon file.
forAsset() - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get a AssetDataBuilder for an asset.
forAsset(Asset) - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get an AssetDataBuilder with standard asset data.
forComponent() - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get a ComponentDataBuilder for a component.
forContainer() - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get a ComponentDataBuilder for a container component
forImageComponent() - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get a ImageComponentDataBuilder for an image component.
FormHandler - Interface in com.adobe.cq.wcm.core.components.services.form
A service that posts form data as JSON to a remote service.
forPage() - Static method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder
Get a PageDataBuilder for a page.
forwardFormData(JSONObject, String) - Method in interface com.adobe.cq.wcm.core.components.services.form.FormHandler
Forward form data to a remote service.
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.Embed.Type
Given a String value, this method returns the enum's value that corresponds to the provided string representation.
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.form.Button.Type
Given a String value, this method returns the enum's value that corresponds to the provided string representation.
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.form.Options.Type
Given a String value, this method returns the enum's value that corresponds to the provided string representation.
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Element
 
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Location
 
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
Given an String value, this method returns the enum's value that corresponds to the provided string representation.
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.ListType
Given a String value, this method returns the enum's value that corresponds to the provided string representation.
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Format
 
fromString(String) - Static method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Type
 
fromStringOrDefault(String, TableOfContents.HeadingLevel) - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
Given an String value, this method returns the enum's value that corresponds to the provided string representation.
FULL_WINDOW - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Show PDF in full window

G

generateId(String, String) - Static method in class com.adobe.cq.wcm.core.components.util.ComponentUtils
Returns an ID based on the prefix, the ID_SEPARATOR and a hash of the path, e.g.
GenericDataBuilder<T extends GenericDataBuilder<T,K>,K> - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Generic data builder that specifies fields available on all data builders.
getAccessibilityLabel() - Method in interface com.adobe.cq.wcm.core.components.models.Button
Returns an accessibility label for the button.
getAccessibilityLabel() - Method in interface com.adobe.cq.wcm.core.components.models.Carousel
Returns an accessibility label that describes the carousel.
getAccessibilityLabel() - Method in interface com.adobe.cq.wcm.core.components.models.LanguageNavigation
Retrieves an accessibility label that describes the language navigation.
getAccessibilityLabel() - Method in interface com.adobe.cq.wcm.core.components.models.LayoutContainer
Returns an accessibility label that describes the container.
getAccessibilityLabel() - Method in interface com.adobe.cq.wcm.core.components.models.Navigation
Retrieves an accessibility label that describes the navigation.
getAccessibilityLabel() - Method in interface com.adobe.cq.wcm.core.components.models.Tabs
Returns an accessibility label that describes the tabs.
getAction() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
Returns the form's submit method (the value of the form's HTML action attribute).
getActions() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns the list of Call-to-Action elements
getActionText() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the action text from the dialog if it is configured there.
getActiveItem() - Method in interface com.adobe.cq.wcm.core.components.models.Tabs
Returns the default active item
getAlt() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
Returns the alternative text of the featured image of either the linked page if a linkURL is available or of the page that contains the component.
getAlt() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the value for the alt attribute of the image.
getAlt() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the value for the alt attribute of the image map area.
getAlternateLanguageLinks() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns a Map of alternate languages of the page.
getAppliedCssClasses() - Method in interface com.adobe.cq.wcm.core.components.models.Component
Returns the style system information associated with the component
getAppliedCssClasses() - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
getAppResourcesPath() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the root path of the application's web resources (e.g.
getAreas() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns a list of image map areas.
getAssetData() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the asset data field value supplier.
getAssetData() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ImageData
Returns the asset associated with the image.
getAssociatedContent() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns a list of resources representing the collections that are associated to this content fragment.
getAttrClass() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
getAttributeNames() - Method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Element
 
getAttributes() - Method in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
Returns the HTML attributes and values for the page item element.
getAuthorName() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The name of the author/owner of the resource.
getAuthorUrl() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
A URL for the author/owner of the resource.
getAutopauseDisabled() - Method in interface com.adobe.cq.wcm.core.components.models.Carousel
Indicates whether automatic pause on hovering the carousel is disabled, or not.
getAutoplay() - Method in interface com.adobe.cq.wcm.core.components.models.Carousel
Indicates whether the carousel should automatically transition between slides or not.
getBackgroundStyle() - Method in interface com.adobe.cq.wcm.core.components.models.Container
Returns the background CSS style to be applied to the component's root element
getBlueprintPath(Resource, LiveRelationshipManager) - Static method in class com.adobe.cq.wcm.core.components.util.LocalizationUtils
Returns the path of the blueprint of the resource.
getBrandSlug() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the brand slug of this page.
getButtonLink() - Method in interface com.adobe.cq.wcm.core.components.models.Button
Returns the button link.
getCacheAge() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The suggested cache lifetime for this resource, in seconds.
getCanonicalLink() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the canonical link of the page.
getChildren() - Method in interface com.adobe.cq.wcm.core.components.models.NavigationItem
Returns the children of this NavigationItem, if any.
getClientId() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the Document Cloud client id
getClientLibCategories() - Method in interface com.adobe.cq.wcm.core.components.models.Page
If this page is associated with a Template, then this method will return the Template's client library categories to be included in the page as defined by the user in the policy.
getClientLibCategoriesJsBody() - Method in interface com.adobe.cq.wcm.core.components.models.Page
If this page is associated with a Template, then this method will return the JavaScript client library categories which are intended specifically to be loaded at the page body end (JavaScript only), as defined by the user in the policy.
getClientLibCategoriesJsHead() - Method in interface com.adobe.cq.wcm.core.components.models.Page
If this page is associated with a Template, then this method will return the JavaScript client library categories which are intended specifically to be loaded up front in the page head (JavaScript only), as defined by the user in the policy.
getCompleted() - Method in interface com.adobe.cq.wcm.core.components.models.ProgressBar
Get the completed percentage
getComponentData() - Method in interface com.adobe.cq.wcm.core.components.models.Image
 
getComponentData() - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
Override this method to provide a different data model for your component.
getComponentPath() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
Returns the component path.
getComponentsResourceTypes() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns a set of resource types for components included in the page.
getConfigPath() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
Returns the configuration path of the widget.
getConstraintMessage() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Returns the message to be displayed when the constraint specified by Text.getType() is not fulfilled.
getContainer() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Editor
Retrieves the container resource associated with this children editor.
getContainerClass() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the CSS class to be applied to the Document Cloud Viewer container
getContentFragmentElements() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the content fragment elements field value supplier.
getCoordinates() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the value for the coords attribute of the image map area.
getCountry() - Method in interface com.adobe.cq.wcm.core.components.models.LanguageNavigationItem
Returns the country of this LanguageNavigationItem.
getCssClassNames() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
Generates some container class names (needed for SPA framework)
getCssClassNames() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the CSS classes defined for the page
getCssIncludes() - Method in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Returns a concatenation of all the HTML CSS link tags defined for the requested resource.
getCssInline() - Method in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Returns a concatenation of all the CSS libraries defined for the requested resource.
getCurrentPage() - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
Getter for current page.
getCurrentPagePath() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
Returns the path of the page containing the component.
getData() - Method in interface com.adobe.cq.wcm.core.components.models.Component
Returns the data layer information associated with the component
getData() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.Embeddable
Returns the data layer information associated with the embeddable
getData() - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
getDataType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the string representation of data type of FragmentData of the element.
getDateFormatString() - Method in interface com.adobe.cq.wcm.core.components.models.List
Returns the date format used to display the last modification date of the list's items.
getDefaultViewMode() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the default view mode
getDelay() - Method in interface com.adobe.cq.wcm.core.components.models.Carousel
Returns the delay (in milliseconds) when automatically transitioning between slides.
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns the description of the content fragment.
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the description field value supplier.
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's description used in the data layer
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns either the description configured in the dialog or the description of the DAM asset, depending on the state of the descriptionFromAsset checkbox.
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns the description of this ListItem.
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the description of this page.
getDescription() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns this teaser's description, if one was defined.
getDesignPath() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Retrieves the page's design path.
getDocumentFileName() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the document file name
getDocumentPath() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the path of the document
getEditorJSON() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns a JSON format string containing information about this fragment.
getElement() - Method in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
Returns the HtmlPageItem.Element type for the page item.
getElements() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns a list of content fragment elements.
getElementsData() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ContentFragmentData
Returns the elements data associated with the content fragment.
getEmbeddableDetails() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the embeddable details value supplier.
getEmbeddableDetails() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.EmbeddableData
Returns the embeddable properties.
getEmbeddableResourceType() - Method in interface com.adobe.cq.wcm.core.components.models.Embed
Returns the resource type of the embeddable.
getEnctype() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
Returns the form's encoding type (the value of the form's HTML enctype attribute).
getErrorMessages() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
This method returns a general error messages which should be displayed inside of the form if the submit action fails.
getExpandedItems() - Method in interface com.adobe.cq.wcm.core.components.models.Accordion
Returns the items that are expanded by default.
getExportedElements() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns a map of elements that are used for creating the JSON export.
getExportedElementsOrder() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns the names of the elements in the correct order.
getExportedItems() - Method in interface com.adobe.cq.wcm.core.components.models.Container
 
getExportedItems() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Returns the map of all exported child items (resource names from Sling Model classes).
getExportedItems() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
 
getExportedItems() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
 
getExportedItems() - Method in interface com.adobe.cq.wcm.core.components.models.Page
 
getExportedItemsOrder() - Method in interface com.adobe.cq.wcm.core.components.models.Container
 
getExportedItemsOrder() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Returns the order of items in the map.
getExportedItemsOrder() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
 
getExportedItemsOrder() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
 
getExportedItemsOrder() - Method in interface com.adobe.cq.wcm.core.components.models.Page
 
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.Component
 
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Returns the type of the resource for which the export is performed.
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Returns the type of the resource for which the export is performed.
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the type of the resource for which the export is performed.
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns the type of the resource for which the export is performed.
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
 
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
 
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.form.Field
 
getExportedType() - Method in interface com.adobe.cq.wcm.core.components.models.Page
 
getExportedType() - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
 
getExtension() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the extension of file to be downloaded.
getExternalizedURL() - Method in interface com.adobe.cq.wcm.core.components.commons.link.Link
The externalized URL which also contains the scheme and host information.
getFacebookAppId() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
getFavicons() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Deprecated.
since 12.2.0
getFeaturedImage(Page) - Static method in class com.adobe.cq.wcm.core.components.util.ComponentUtils
Returns the resource holding the properties of the featured image of the page.
getFilename() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the filename of the file to be downloaded.
getFileReference() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the file reference of the current image, if one exists.
getFormat() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.AssetData
Returns the asset format
getFormat() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the format field value supplier.
getFormat() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the mime type of the file to be downloaded.
getGridResourceType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Returns resource type that is used for the internal responsive grid.
getHeading() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
getHeadingElement() - Method in interface com.adobe.cq.wcm.core.components.models.Accordion
Returns the HTML element to use for accordion headers.
getHeight() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the height of the base DAM asset image, the one from the src attribute.
getHeight() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The height in pixels required to display the HTML.
getHelpMessage() - Method in interface com.adobe.cq.wcm.core.components.models.form.Field
Returns the message for the help block.
getHref() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the value for the href attribute of the image map area.
getHtml() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the value of a multiline text element converted to HTML.
getHtml() - Method in interface com.adobe.cq.wcm.core.components.models.Embed
Returns an embeddable HTML snippet.
getHtml() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The HTML required to display the resource.
getHtmlAttributes() - Method in interface com.adobe.cq.wcm.core.components.commons.link.Link
Returns a Map with attributes for HTML anchor tag for this link.
getHtmlPageItems() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns a list of HTML items that should be included in the page
getIcon() - Method in interface com.adobe.cq.wcm.core.components.models.Button
Returns the button icon identifier.
getIconAbbreviation() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
Retrieves the icon abbreviation of this children editor item.
getIconName() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
Retrieves the icon name of this children editor item.
getIconPath() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
Retrieves the icon path of this children editor item.
getIconPath() - Method in interface com.adobe.cq.wcm.core.components.models.PWA
The path to the icon of this PWA
getId() - Method in interface com.adobe.cq.wcm.core.components.models.Component
Returns the HTML id of the the component's root element
getId() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.AssetData
Returns the JCR id of the asset
getId() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the ID field value supplier.
getId() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's ID
getId() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
Returns the form's id (the value of the form's HTML id attribute).
getId() - Method in interface com.adobe.cq.wcm.core.components.models.form.Field
Returns an unique identifier for this field.
getId() - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
 
getId(Resource, Page, ComponentContext) - Static method in class com.adobe.cq.wcm.core.components.util.ComponentUtils
getId(Resource, Page, String, ComponentContext) - Static method in class com.adobe.cq.wcm.core.components.util.ComponentUtils
Get the ID property value if set (using ComponentUtils.getPropertyId(Resource), otherwise generate a new ID (using ComponentUtils.generateId(Resource, Page, String, ComponentContext).
getIFrameAspectRatio() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
getIFrameHeight() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
getIFrameSrc() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
getIFrameWidth() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
getIgnoreClasses() - Method in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Returns an array of all ignore class names set in configuration policy
getImageLink() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the image's link.
getImageResource() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns the image resource for this teaser.
getIncludeClasses() - Method in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Returns an array of all include class names set in configuration policy
getInheritedValue() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
getIntValue() - Method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
 
getItems() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Editor
Retrieves the child items associated with this children editor.
getItems() - Method in interface com.adobe.cq.wcm.core.components.models.Breadcrumb
Creates collection of pages(from site hierarchy of current page) for the breadcrumb component
getItems() - Method in interface com.adobe.cq.wcm.core.components.models.Container
Returns a list of container items
getItems() - Method in interface com.adobe.cq.wcm.core.components.models.form.Options
Returns the list of all the options.
getItems() - Method in interface com.adobe.cq.wcm.core.components.models.LanguageNavigation
Returns the list of language navigation items related to the current page.
getItems() - Method in interface com.adobe.cq.wcm.core.components.models.List
Deprecated.
since 12.1.0: use List.getListItems() instead
getItems() - Method in interface com.adobe.cq.wcm.core.components.models.Navigation
Returns the list of navigation items.
getJsAndCssIncludes() - Method in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Returns a concatenation of all the HTML JS script and CSS link tags defined for the requested resource.
getJsIncludes() - Method in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Returns a concatenation of all the HTML JS script tags defined for the requested resource.
getJsInline() - Method in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Returns a concatenation of all the JS libraries defined for the requested resource.
getJson() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the JSON string of the component's properties used in the data layer
getJson() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Deprecated.
since 12.1.0
getKeywords() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns an array with the page's keywords.
getLanguage() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the language field value supplier.
getLanguage() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.PageData
Returns the page language used in the data layer
getLanguage() - Method in interface com.adobe.cq.wcm.core.components.models.LanguageNavigationItem
Returns the language of this LanguageNavigationItem.
getLanguage() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the language of this page, if one has been defined.
getLanguageRoot(Resource, LanguageManager) - Static method in class com.adobe.cq.wcm.core.components.util.LocalizationUtils
Returns the language root of the resource.
getLastModified() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns the date when this ListItem was last modified.
getLastModifiedDate() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.AssetData
Returns the asset last modified date
getLastModifiedDate() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the last modified date field value supplier.
getLastModifiedDate() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's last modified date using ISO 8601 standard
getLastModifiedDate() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the last modified date of this page.
getLayout() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
getLayout() - Method in interface com.adobe.cq.wcm.core.components.models.LayoutContainer
Returns the LayoutContainer.LayoutType to be used by the container component
getLayout() - Method in enum com.adobe.cq.wcm.core.components.models.LayoutContainer.LayoutType
 
getLayoutType(String) - Static method in enum com.adobe.cq.wcm.core.components.models.LayoutContainer.LayoutType
 
getLazyThreshold() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the number of pixels in advance of an image becoming visible that a lazy loading image should load.
getLevel() - Method in interface com.adobe.cq.wcm.core.components.models.NavigationItem
Returns the depth level of this NavigationItem.
getLink() - Method in interface com.adobe.cq.wcm.core.components.models.Button
Deprecated.
getLink() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Deprecated.
getLink() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the link of the image area.
getLink() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns the link of this ListItem.
getLink() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns the primary link of this teaser.
getLink() - Method in interface com.adobe.cq.wcm.core.components.models.Title
Returns the Title's link.
getLinkUrl() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the link URL field value supplier.
getLinkUrl() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's link URL used in the data layer
getLinkURL() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Deprecated.
Please use Teaser.getLink()
getLinkURL() - Method in interface com.adobe.cq.wcm.core.components.models.Title
Deprecated.
Please use Title.getLink()
getListItems() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Returns a list of content fragments.
getListItems() - Method in interface com.adobe.cq.wcm.core.components.models.List
Returns the list's items collection, as ListItems elements.
getListType() - Method in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Returns the configured list type taking into account the configuration policy
getLiveCopyPath(Resource, LiveRelationshipManager) - Static method in class com.adobe.cq.wcm.core.components.util.LocalizationUtils
Returns the path of the live copy of the resource.
getLocale() - Method in interface com.adobe.cq.wcm.core.components.models.LanguageNavigationItem
Returns the locale of this LanguageNavigationItem.
getLocalizationRoot(Resource, ResourceResolver, LanguageManager, LiveRelationshipManager) - Static method in class com.adobe.cq.wcm.core.components.util.LocalizationUtils
Returns the localization root of the given resource.
getLocalizedFragmentVariationPath() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
Returns the localized path of the experience fragment variation if the experience fragment resource is defined in the template.
getLocation() - Method in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
Returns the HtmlPageItem.Location where the page item should be inserted.
getMainContentSelector() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the selector for the main content element of the page (used by the "skip to main content" accessibility feature)
getManifestPath() - Method in interface com.adobe.cq.wcm.core.components.models.PWA
The relative path to the web manifest
getMappedURL() - Method in interface com.adobe.cq.wcm.core.components.commons.link.Link
The mapped URL, which supports mapping and vanity path.
getMetadata() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
getMethod() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
Returns the form's submit method (the value of the form's HTML method attribute).
getName() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
Retrieves the node name of this children editor item.
getName() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the technical name of the element.
getName() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns the technical name of the content fragment.
getName() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
Returns the technical name of the experience fragment.
getName() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
Returns the form's name (the value of the form's HTML name attribute).
getName() - Method in interface com.adobe.cq.wcm.core.components.models.form.Field
Returns the value of the HTML name attribute.
getName() - Method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Element
 
getName() - Method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Location
 
getName() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns the name of this ListItem.
getOptions() - Method in interface com.adobe.cq.wcm.core.components.services.embed.UrlProcessor.Result
Returns the data from the processor that was able to process the URL.
getPage() - Method in interface com.adobe.cq.wcm.core.components.models.NavigationItem
Deprecated.
since 12.1.0 as NavigationItem relies on ListItem
getParagraphs() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Returns the paragraphs of a multiline text element.
getParentId() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the parent ID field value supplier.
getParentId() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's parent ID
getPath() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns the path of this ListItem.
getPaths() - Method in interface com.adobe.cq.wcm.core.components.models.ComponentFiles
Returns a list of paths for files inside the components (specified by the resource types) that match the given filter regex.
getPlaceholder() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Returns the value of the placeholder HTML attribute.
getPretitle() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns this teaser's pretitle, if one was defined.
getProcessor() - Method in interface com.adobe.cq.wcm.core.components.services.embed.UrlProcessor.Result
Returns the name of the processor that was able to process the URL.
getProp() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
getProvider(String) - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedClient
Gets a suitable oEmbed provider for the given URL.
getProviderName() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The name of the resource provider.
getProviderUrl() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The url of the resource provider.
getRedirect() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
This method returns the redirect url property of this form.
getRedirectTarget() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the target page if this page is redirecting to another page.
getReference() - Method in interface com.adobe.cq.wcm.core.components.commons.link.Link
Returns the referenced WCM/DAM object.
getRelativeCoordinates() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the value for a relative unit representation of the coords attribute of the image map area.
getRelativePath() - Method in interface com.adobe.cq.wcm.core.components.models.Search
Relative path of the search component in the current page.
getRemaining() - Method in interface com.adobe.cq.wcm.core.components.models.ProgressBar
Get the remaining percentage
getReportSuiteId() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the Adobe Analytics report suite id
getRequiredMessage() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Returns the message to be displayed if the field is mandatory.
getResourceTypeForDropArea() - Method in interface com.adobe.cq.wcm.core.components.models.form.Container
Returns the resource type for the "new" section in the core form container where other input components will be dropped.
getResponse(String) - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedClient
Gets the embedding information from the oEmbed provider.
getResult() - Method in interface com.adobe.cq.wcm.core.components.models.Embed
Returns the result from the processor that can process the given URL.
getResultsSize() - Method in interface com.adobe.cq.wcm.core.components.models.Search
The maximal number of results fetched by a search request.
getRobotsTags() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns a list of robots meta tags configured for the page.
getRoleAttribute() - Method in interface com.adobe.cq.wcm.core.components.models.LayoutContainer
Returns a role attribute to be used on the container.
getRows() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Returns the number of rows to display in case this item's type is a textarea.
getSearchRootPagePath() - Method in interface com.adobe.cq.wcm.core.components.models.Search
Gets the path of the localized search root.
getSearchTermMinimumLength() - Method in interface com.adobe.cq.wcm.core.components.models.Search
The minimum length of the search term to start the search.
getServiceWorkerPath() - Method in interface com.adobe.cq.wcm.core.components.models.PWA
The relative path to the service worker
getShape() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the value for the shape attribute of the image map area.
getShownItems() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the shown items field value supplier.
getShownItems() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ContainerData
Returns the shown items for container components
getSize() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the size of the file to be downloaded.
getSmartCropRendition() - Method in interface com.adobe.cq.wcm.core.components.models.Image
 
getSmartTags() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.AssetData
Returns the asset smart tags
getSmartTags() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the smart tags field value supplier.
getSpecifiedValue() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
getSrc() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
Returns the src text of the featured image of either the linked page if a linkURL is available or of the page that contains the component.
getSrc() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the value for the src attribute of the image.
getSrcset() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the value for the srcset html attribute of the image.
getSrcUriTemplate() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns a URI template representation of the image src attribute that can be variable expanded to a URI reference.
getStartLevel() - Method in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Returns the start level taking into account the configuration policy
getStaticDesignPath() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Retrieves the static design path if static.css exists in the design path.
getStopLevel() - Method in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Returns the stop level taking into account the configuration policy
getTagName() - Method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
Returns the HTML tag name corresponding to this heading level
getTagName() - Method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.ListType
Returns the HTML tag name for this enum type of list
getTags() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.AssetData
Returns the asset tags
getTags() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the tags field value supplier.
getTags() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.PageData
Returns the page tags used in the data layer
getTarget() - Method in interface com.adobe.cq.wcm.core.components.models.ImageArea
Returns the value for the target attribute of the image map area.
getTeaserResource() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns a wrapped resource of the item which is used to render the item as a Teaser component.
getTemplateName() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the template name of the currently used template.
getTemplatePath() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the template path field value supplier.
getTemplatePath() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.PageData
Returns the page template used in the data layer
getText() - Method in interface com.adobe.cq.wcm.core.components.models.Button
Returns the button text.
getText() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the text field value supplier.
getText() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's text used in the data layer
getText() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ContentFragmentData.ElementData
Returns the value of content fragment element as string
getText() - Method in interface com.adobe.cq.wcm.core.components.models.form.OptionItem
Return the text for this item.
getText() - Method in interface com.adobe.cq.wcm.core.components.models.Text
Retrieves the text value to be displayed.
getText() - Method in interface com.adobe.cq.wcm.core.components.models.Title
Returns the text to be displayed as title.
getThemeColor() - Method in interface com.adobe.cq.wcm.core.components.models.PWA
The theme color of the site sometimes used to color the address bar of the browser
getThumbnailHeight() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The height of the optional thumbnail.
getThumbnailUrl() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
A URL to a thumbnail image representing the resource.
getThumbnailWidth() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The width of the optional thumbnail.
getTitle() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
Retrieves the title (component name) of this children editor item.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the title of the element.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns the title of the content fragment.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the title field value supplier.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's title used in the data layer
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ContentFragmentData.ElementData
Returns the title of the content fragment element
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns either the title configured in the dialog or the title of the DAM asset, depending on the state of the titleFromAsset checkbox.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.form.Field
Returns the title of the field (text displayed on the field).
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the value for the image's title attribute, if one was set.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Returns the title of this ListItem.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Returns the title of this page.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns this teaser's title, if one was defined.
getTitle() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
A text title, describing the resource.
getTitleType() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the HTML element to be used for the title as defined in the component policy.
getTitleType() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Returns the HTML element type (h1-h6) used for the title.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Returns the type of the content fragment.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the type field value supplier.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.ComponentData
Returns the component's type used in the data layer
getType() - Method in interface com.adobe.cq.wcm.core.components.models.Embed
Returns the embed input Embed.Type.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.form.Button
Returns this button's type.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.form.Options
Returns the type of the options element.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Returns the type of the input field such as text, textarea, date, email etc.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns Document Cloud Viewer embed type.
getType() - Method in interface com.adobe.cq.wcm.core.components.models.Title
Returns the HTML element type (h1-h6) used for the markup.
getType() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The oEmbed type.
getURL() - Method in interface com.adobe.cq.wcm.core.components.commons.link.Link
The link URL, supports context path and escaping.
getUrl() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.AssetData
Returns the asset URL
getUrl() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerSupplier
Get the URL field value supplier.
getUrl() - Method in interface com.adobe.cq.wcm.core.components.models.datalayer.PageData
Returns the page URL used in the data layer
getUrl() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Returns the url to the asset.
getUrl() - Method in interface com.adobe.cq.wcm.core.components.models.Embed
Returns the URL of an embeddable item.
getURL() - Method in interface com.adobe.cq.wcm.core.components.models.ListItem
Deprecated.
getUrl() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The source URL of the image.
getUuid() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the value for the image's uuid, if one was set.
getValue() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
Retrieves the value (jcr:title) of this children editor item.
getValue() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the value of the element.
getValue(Class<T>) - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns the value of the element.
getValue() - Method in interface com.adobe.cq.wcm.core.components.models.form.Field
Returns the value of the HTML value attribute.
getValue() - Method in interface com.adobe.cq.wcm.core.components.models.form.OptionItem
Returns the value of this item.
getValue() - Method in enum com.adobe.cq.wcm.core.components.models.form.Options.Type
Returns the string value of this enum constant.
getValue() - Method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
 
getValue() - Method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.ListType
 
getValue() - Method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Format
 
getValue() - Method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Type
 
getVersion() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The oEmbed version number.
getViewerConfigJson() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns the Document Cloud Viewer configuration JSON
getWidth() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the width of the base DAM asset image, the one from the src attribute.
getWidth() - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse
The width in pixels required to display the HTML.
getWidths() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Returns the alternative image widths (in pixels), configured through the Image.PN_DESIGN_ALLOWED_RENDITION_WIDTHS content policy.

H

hasCloudconfigSupport() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Checks if there's support for cloudconfig script tags so they can be added to page header/footer
hasFacebookSharing() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
hasPinterestSharing() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
hideTitle() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Checks if the title (label of the field) should be visually hidden; this is required if the title is mandatory only for accessibility purposes.
hideTitleLink() - Method in interface com.adobe.cq.wcm.core.components.models.Download
Checks if the title link should be hidden.
HtmlPageItem - Interface in com.adobe.cq.wcm.core.components.models
This interface defines items that can be included on a page.
HtmlPageItem.Element - Enum in com.adobe.cq.wcm.core.components.models
enum that defines the possible HTML elements for a page item
HtmlPageItem.Location - Enum in com.adobe.cq.wcm.core.components.models
enum that defines possible insert positions for a page item.
HtmlPageItemConfig - Annotation Type in com.adobe.cq.wcm.core.components.config
Context-aware configuration holding information on an item to be included in pages: - scripts - links - meta This configuration is meant to be used as a context-aware resource.
HtmlPageItemsConfig - Annotation Type in com.adobe.cq.wcm.core.components.config
Context-aware configuration holding information on items to be included in pages: - scripts - links - meta This configuration is meant to be used as a context-aware resource.

I

iconAbbreviation - Variable in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 
iconName - Variable in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 
iconPath - Variable in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 
ID_SEPARATOR - Static variable in class com.adobe.cq.wcm.core.components.util.ComponentUtils
Name of the separator character used between prefix and hash when generating an ID, e.g.
IdRequiredDataBuilder<T extends GenericDataBuilder<T,K>,K> - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Temporary data builder that requires an ID supplier to be set.
Image - Interface in com.adobe.cq.wcm.core.components.models
Defines the Image Sling Model used for the /apps/core/wcm/components/image component.
ImageArea - Interface in com.adobe.cq.wcm.core.components.models
Interface for an image map area, used by the Image model.
ImageComponentDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data builder for image components.
ImageData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
Interface defining data for image components.
IN_LINE - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Show PDF inline
InheritedField - Class in com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited
 
InheritedField() - Constructor for class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
initModel() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
 
isActionsEnabled() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Checks if the teaser has Call-to-Action elements
isActive() - Method in interface com.adobe.cq.wcm.core.components.models.NavigationItem
Returns true if the page contained by this navigation item is active.
isBorderless() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the document is to be diplayed borderless
isClientlibsAsync() - Method in interface com.adobe.cq.wcm.core.components.models.Page
Checks if the Javascript libraries should be loaded asynchronously.
isConfigured() - Method in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
Simple boolean flag to check if the experience fragment variation and its underlying experience fragment is configured.
isControlsPrepended() - Method in interface com.adobe.cq.wcm.core.components.models.Carousel
Checks if the control elements should be placed in front of the carousel items.
isCurrent() - Method in interface com.adobe.cq.wcm.core.components.models.NavigationItem
Returns true if the page contained by this navigation item is the current page.
isDataLayerEnabled(Resource) - Static method in class com.adobe.cq.wcm.core.components.util.ComponentUtils
Check if data layer is enabled.
isDecorative() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Indicates whether the image is decorative.
isDisabled() - Method in interface com.adobe.cq.wcm.core.components.models.form.OptionItem
Returns true if item should be disabled and therefore not clickable, otherwise false.
isDmImage() - Method in interface com.adobe.cq.wcm.core.components.models.Image
 
isDockPageControls() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the page controls should be docked
isEmpty() - Method in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
isEnabled() - Method in interface com.adobe.cq.wcm.core.components.models.PWA
Returns true if PWA features are enabled false otherwise
isFacebookEnabled() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
isImageLinkHidden() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Checks if the link on the image is hidden.
isLazyEnabled() - Method in interface com.adobe.cq.wcm.core.components.models.Image
Indicates if the image should be rendered lazily or not.
isLinkDisabled() - Method in interface com.adobe.cq.wcm.core.components.models.Title
Checks if link is disabled on the title.
isMultiLine() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns true if this is a multiline text element, i.e.
isMultiValue() - Method in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment.DAMContentElement
Returns true if this is a multi-valued element value.
isOverride() - Method in class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.InheritedField
 
isPinterestEnabled() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
isReadOnly() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Checks if the field should be rendered read only.
isRequired() - Method in interface com.adobe.cq.wcm.core.components.models.form.Text
Checks if the this text field is mandatory.
isRichText() - Method in interface com.adobe.cq.wcm.core.components.models.Text
Checks if the text to be displayed is rich text or not.
isSelected() - Method in interface com.adobe.cq.wcm.core.components.models.form.OptionItem
Returns true if item should be initially selected, otherwise false.
isShowAnnotationTools() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the annotation tools should be displayed
isShowDownloadPdf() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the download button should be shown
isShowFullScreen() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the fullscreen button should be shown
isShowLeftHandPanel() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the left hand panel should be showmn
isShowPageControls() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the page controls should be shown
isShowPrintPdf() - Method in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Returns true if the print button should be shown
isSingleExpansion() - Method in interface com.adobe.cq.wcm.core.components.models.Accordion
Indicates whether the accordion forces a single item to be expanded at a time or not.
isSocialMediaEnabled() - Method in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
isTitleLinkHidden() - Method in interface com.adobe.cq.wcm.core.components.models.Teaser
Checks if the link on the title is hidden.
isUnsafeContext(String) - Method in interface com.adobe.cq.wcm.core.components.services.embed.OEmbedClient
Determines whether the provider response HTML is allowed to be displayed in an unsafe context.
isValid() - Method in interface com.adobe.cq.wcm.core.components.commons.link.Link
Checks if the link defined for the component is valid.
Item - Class in com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor
Defines an Item class, used by the children editor Editor Sling Model.
Item(SlingHttpServletRequest, Resource) - Constructor for class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 

J

JSON_LAZY_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Deprecated.
since 12.1.0
JSON_PN_ELEMENTS - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Name of the property (in JSON export) that provides an object containing the elements of the content fragment; the keys of the object properties refer to the element names
JSON_PN_ELEMENTS_ORDER - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Name of the property (in JSON export) that provides an array containing the names of the elements of the content fragment in the correct order
JSON_PN_ITEMS - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the property (in JSON export) that provides the content fragment items.
JSON_PN_MODEL - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.DAMContentFragment
Name of the property (in JSON export) that provides the path to the model of the content fragment
JSON_SMART_IMAGES - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Deprecated.
since 12.1.0
JSON_SMART_SIZES - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Deprecated.
since 12.1.0

L

LanguageNavigation - Interface in com.adobe.cq.wcm.core.components.models
Defines the LanguageNavigation Sling Model used for the /apps/core/wcm/components/languagenavigation component.
LanguageNavigationItem - Interface in com.adobe.cq.wcm.core.components.models
Interface for a single language navigation item, used by the LanguageNavigation model.
LayoutContainer - Interface in com.adobe.cq.wcm.core.components.models
Defines the LayoutContainer Sling Model used for the /apps/core/wcm/components/container component.
LayoutContainer.LayoutType - Enum in com.adobe.cq.wcm.core.components.models
Enumeration of supported layout types for the container component
Link<T> - Interface in com.adobe.cq.wcm.core.components.commons.link
Describes a link target.
linkItems() - Method in interface com.adobe.cq.wcm.core.components.models.List
Returns true if the list's items should link to the corresponding Pages they represent.
List - Interface in com.adobe.cq.wcm.core.components.models
Defines the List Sling Model used for the /apps/core/wcm/components/list component.
ListItem - Interface in com.adobe.cq.wcm.core.components.models
Interface for a generic list item, used by the List and Search models.
LocalizationUtils - Class in com.adobe.cq.wcm.core.components.util
 
LocalizationUtils() - Constructor for class com.adobe.cq.wcm.core.components.util.LocalizationUtils
 

M

MANIFEST_NAME - Static variable in interface com.adobe.cq.wcm.core.components.models.PWA
Name of the manifest file that provides information about the PWA
map(String, SlingHttpServletRequest) - Method in interface com.adobe.cq.wcm.core.components.services.link.PathProcessor
Applies mappings to the given path.

N

name - Variable in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 
Navigation - Interface in com.adobe.cq.wcm.core.components.models
Defines the Navigation Sling Model used for the /apps/core/wcm/components/navigation component.
NavigationItem - Interface in com.adobe.cq.wcm.core.components.models
Interface for a single navigation item, used by the Breadcrumb and Navigation models.
NN_ACTIONS - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the child node where the Call-to-Action elements are stored
NN_ATTRIBUTES - Static variable in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
Deprecated.
since 12.18.0
NN_PAGE_FEATURED_IMAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Name of the node holding the properties of the featured image of the page.
NN_SLING_CONFIGS - Static variable in class com.adobe.cq.wcm.core.components.util.ComponentUtils
Name of the node holding the context aware configurations below /conf/{site-name};

O

OEmbedClient - Interface in com.adobe.cq.wcm.core.components.services.embed
A service that allows finding providers and embedding information for URLs.
OEmbedResponse - Interface in com.adobe.cq.wcm.core.components.services.embed
Defines the oEmbed HTTP response object.
OEmbedResponse.Format - Enum in com.adobe.cq.wcm.core.components.services.embed
Enumeration of oEmbed response formats.
OEmbedResponse.Type - Enum in com.adobe.cq.wcm.core.components.services.embed
Enumeration of oEmbed response types.
OPTION_ASYNC - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the HTL option to inject the async attribute into the javascript script tag.
OPTION_CATEGORIES - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the HTL option used to inject the clientlib categories.
OPTION_CROSSORIGIN - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the HTL option to inject the crossorigin attribute into the javascript script tag.
OPTION_DEFER - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the HTL option to inject the defer attribute into the javascript script tag.
OPTION_FILTER_REGEX - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the option used to specify the regular expression that needs to be matched by client library categories to be collected.
OPTION_FILTER_REGEX - Static variable in interface com.adobe.cq.wcm.core.components.models.ComponentFiles
Name of the option used to specify the regular expression that needs to be matched by files to be collected.
OPTION_INHERITED - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the option used to specify if client libraries should be searched up the inheritance chain (using Sling resource supertype).
OPTION_INHERITED - Static variable in interface com.adobe.cq.wcm.core.components.models.ComponentFiles
Name of the option used to specify if files should be searched up the inheritance chain (using Sling resource supertype).
OPTION_INHERITED_DEFAULT - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Default value for OPTION_INHERITED.
OPTION_INHERITED_DEFAULT - Static variable in interface com.adobe.cq.wcm.core.components.models.ComponentFiles
Default value for OPTION_INHERITED.
OPTION_MEDIA - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the HTL option to inject the media attribute into the stylesheet link tag.
OPTION_ONLOAD - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the HTL option to inject the onload attribute into the javascript script tag.
OPTION_RESOURCE_TYPES - Static variable in interface com.adobe.cq.wcm.core.components.models.ClientLibraries
Name of the option used to specify the Collection of resource types.
OPTION_RESOURCE_TYPES - Static variable in interface com.adobe.cq.wcm.core.components.models.ComponentFiles
Name of the option used to specify the Collection of resource types.
OptionItem - Interface in com.adobe.cq.wcm.core.components.models.form
Interface for a single item of the Options form element.
Options - Interface in com.adobe.cq.wcm.core.components.models.form
Defines the form Options Sling Model used for the /apps/core/wcm/components/form/options component.
Options.Type - Enum in com.adobe.cq.wcm.core.components.models.form
Defines the Options type.

P

Page - Interface in com.adobe.cq.wcm.core.components.models
Defines the Page Sling Model used for the /apps/core/wcm/components/page component.
PageData - Interface in com.adobe.cq.wcm.core.components.models.datalayer
Interface defining data for page components.
PageDataBuilder - Class in com.adobe.cq.wcm.core.components.models.datalayer.builder
Data layer builder for pages.
PageImageThumbnail - Class in com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited
Defines a Sling Model used by the core/wcm/components/commons/editor/dialog/pageimagethumbnail/v1/pageimagethumbnail dialog widget that displays a thumbnail of the featured image of either the linked page if a linkURL is available or of the page that contains the component.
PageImageThumbnail() - Constructor for class com.adobe.cq.wcm.core.components.commons.editor.dialog.inherited.PageImageThumbnail
 
PathProcessor - Interface in com.adobe.cq.wcm.core.components.services.link
A service that can process a given path.
PdfViewer - Interface in com.adobe.cq.wcm.core.components.models
Defines the PdfViewer component model.
PN_ACTION_LINK - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the resource property that stores the Call-to-Action link
PN_ACTION_TEXT - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the policy property that defines the text to be displayed on the action.
PN_ACTION_TEXT - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the resource property that stores the Call-to-Action text
PN_ACTIONS_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not Call-to-Actions are disabled
PN_ACTIONS_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the resource property that defines whether or not the teaser has Call-to-Action elements
PN_ALT_VALUE_FROM_DAM - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that will indicate if the value of the alt attribute should be populated from DAM if the component is configured with a file reference.
PN_ALT_VALUE_FROM_PAGE_IMAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the value of the alt attribute should be inherited from the featured image of the page.
PN_APP_RESOURCES_CLIENTLIB - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Name of the configuration policy property that will store the category of the client library from which web application resources will be served.
PN_ASPECT_RATIO - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
Name of the resource property that defines the aspect ratio of the iFrame hosting the YouTube video.
PN_AUTOPAUSE_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Carousel
Name of the resource property that indicates whether automatic pause on hovering the carousel is disabled, or not.
PN_AUTOPLAY - Static variable in interface com.adobe.cq.wcm.core.components.models.Carousel
Name of the resource property that indicates whether to automatically transition between slides, or not.
PN_AUTOPLAY - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_BACKGROUND_COLOR - Static variable in interface com.adobe.cq.wcm.core.components.models.Container
Name of the resource property that indicates the background color
PN_BACKGROUND_COLOR_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Container
Name of the configuration policy property that indicates if background colors are enabled
PN_BACKGROUND_COLOR_SWATCHES_ONLY - Static variable in interface com.adobe.cq.wcm.core.components.models.Container
Name of the configuration policy property that indicates if background colors are to be restricted to predefined values
PN_BACKGROUND_IMAGE_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Container
Name of the configuration policy property that indicates if background images are enabled
PN_BACKGROUND_IMAGE_REFERENCE - Static variable in interface com.adobe.cq.wcm.core.components.models.Container
Name of the resource property that indicates that path to the background image
PN_BORDERLESS - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to enable full screen borderless
PN_COLLECT_ALL_PAGES - Static variable in interface com.adobe.cq.wcm.core.components.models.Navigation
Name of the resource / configuration policy property that defines if the resulted navigation tree should collect all child pages of the configured Navigation.PN_NAVIGATION_ROOT.
PN_COMPLETED - Static variable in interface com.adobe.cq.wcm.core.components.models.ProgressBar
Name of property that defines the completion percentage.
PN_CONTROLS_PREPENDED - Static variable in interface com.adobe.cq.wcm.core.components.models.Carousel
Name of the policy property that defines whether the control elements should be placed in front of the carousel items.
PN_DATE_FORMAT - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property indicating which date format should be used when the list items render their modification date.
PN_DEFAULT_VIEW_MODE - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Defines the display view
PN_DELAY - Static variable in interface com.adobe.cq.wcm.core.components.models.Carousel
Name of the resource property that indicates the delay (in milliseconds) when automatically transitioning between slides.
PN_DESCRIPTION_FROM_ASSET - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the resource property that defines whether or not the description value is taken from the configured asset.
PN_DESCRIPTION_FROM_PAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the resource property that defines whether or not the description value is taken from the linked page.
PN_DESCRIPTION_HIDDEN - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not the description is hidden.
PN_DESIGN_ALLOWED_EMBEDDABLES - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the configuration policy property that defines the embeddables that are allowed to be selected by an author.
PN_DESIGN_ALLOWED_RENDITION_WIDTHS - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that will store the allowed rendition widths for an image.
PN_DESIGN_ASSET_DELIVERY_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that controls whether assets will be delivered through Dynamic Media.
PN_DESIGN_AUTOPLAY_DEFAULT_VALUE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_AUTOPLAY_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_DEFAULT_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.Title
Name of the configuration policy property that will store the default value for this title's HTML element type.
PN_DESIGN_DYNAMIC_MEDIA_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that controls whether Dynamic Media features are used by Core component.
PN_DESIGN_EMBEDDABLES_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the configuration policy property that indicates whether the embeddable input type is disabled.
PN_DESIGN_HEADING_ELEMENT - Static variable in interface com.adobe.cq.wcm.core.components.models.Accordion
Name of the configuration policy property that stores the default value for the accordion heading's HTML element.
PN_DESIGN_HTML_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the configuration policy property that indicates whether the html input type is disabled.
PN_DESIGN_JPEG_QUALITY - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that will store the image quality for an image.
PN_DESIGN_LAZY_LOADING_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that will indicate if lazy loading should be disabled.
PN_DESIGN_LAZY_THRESHOLD - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that indicate the number of pixels, in advance of becoming visible, that a lazy loading image should load.
PN_DESIGN_LOOP_DEFAULT_VALUE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_LOOP_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_MUTE_DEFAULT_VALUE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_MUTE_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_PLAYS_INLINE_DEFAULT_VALUE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_PLAYS_INLINE_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_RELATED_VIDEOS_DEFAULT_VALUE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_RELATED_VIDEOS_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_DESIGN_RESIZE_WIDTH - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that will be used for resizing the base images, the ones from src attribute.
PN_DESIGN_URL_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the configuration policy property that indicates whether the url input type is disabled.
PN_DISPLAY_FILENAME - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the policy property that defines whether the filename will be displayed.
PN_DISPLAY_FORMAT - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the policy property that defines whether the file's format will be displayed.
PN_DISPLAY_ITEM_AS_TEASER - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the boolean resource property indication if the items should render a link to the page they represent.
PN_DISPLAY_MODE - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Name of the required property that stores whether a single text element (singleText) or multiple elements (multi) are displayed.
PN_DISPLAY_POPUP_TITLE - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the image's caption will be rendered as a popup.
PN_DISPLAY_SIZE - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the policy property that defines whether the file's size will be displayed.
PN_DISPLAY_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Defines the display type
PN_DOCK_PAGE_CONTROLS - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to dock controls to bottom
PN_DOCUMENT_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Defines the path of the PDF to display
PN_ELEMENT - Static variable in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
Deprecated.
since 12.18.0
PN_ELEMENT_NAMES - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Name of the optional resource property that stores the names of the elements to be used.
PN_ELEMENT_NAMES - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the optional resource property that stores the names of the elements to be used.
PN_EMBEDDABLE_RESOURCE_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the resource property that defines the resource type of an embeddable.
PN_FACEBOOK_APP_ID - Static variable in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
PN_FAVICON_ICO - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Key used for the regular favicon file.
PN_FAVICON_PNG - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Key for the PNG-format favicon file.
PN_FLIP_HORIZONTAL - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the current image should be flipped horizontally.
PN_FLIP_VERTICAL - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the current image should be flipped vertically.
PN_FRAGMENT_VARIATION_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.ExperienceFragment
Name of the configuration policy property that specifies the experience fragment variation path.
PN_HEIGHT - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
Name of the resource property that defines the height of the iFrame hosting the YouTube video.
PN_HIDE_CURRENT - Static variable in interface com.adobe.cq.wcm.core.components.models.Breadcrumb
Name of the resource property that will indicate if the current page should not be present in the collection returned by Breadcrumb.getItems().
PN_HIDE_TITLE_LINK - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the policy property that defines whether the title links should be hidden.
PN_HREF - Static variable in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
HREF attribute for HtmlPageItem.Element.LINK page items
PN_HTML - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the resource property that defines an embeddable HTML snippet.
PN_ID - Static variable in interface com.adobe.cq.wcm.core.components.models.Component
Name of the resource property that indicates the HTML id for the component.
PN_IGNORE_CLASSES - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the configuration policy property, if set, titles with those class names or contained within elements of the indicated class names will be ignored.
PN_IMAGE_FROM_PAGE_IMAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the image is inherited from the featured image of the page.
PN_IMAGE_LINK_HIDDEN - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not the image link is hidden.
PN_IMAGE_MODIFIERS - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the current image should has Image Modifiers settings.
PN_IMAGE_SERVER_URL - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate imageServerUrl.
PN_INCLUDE_CLASSES - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the configuration policy property, if set, only titles with those class names or contained within elements of the indicated class names will be considered
PN_INLINE - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the resource property that defines whether or not the download item should be displayed inline vs.
PN_IS_DECORATIVE - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that will indicate if the image is decorative.
PN_LAYOUT - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
Name of the resource property that defines the layout type of the youtube video.
PN_LAYOUT - Static variable in interface com.adobe.cq.wcm.core.components.models.LayoutContainer
Name of the resource property that indicates the layout that should be used by the container component.
PN_LINK_ACCESSIBILITY_LABEL - Static variable in interface com.adobe.cq.wcm.core.components.commons.link.Link
Deprecated.
PN_LINK_ITEMS - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the boolean resource property indication if the items should render a link to the page they represent.
PN_LINK_TARGET - Static variable in interface com.adobe.cq.wcm.core.components.commons.link.Link
Property name for storing link target.
PN_LINK_TITLE_ATTRIBUTE - Static variable in interface com.adobe.cq.wcm.core.components.commons.link.Link
Deprecated.
PN_LINK_URL - Static variable in interface com.adobe.cq.wcm.core.components.commons.link.Link
Default property name for storing link URL.
PN_LIST_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the optional resource property that stores the list type of table of contents.
PN_LOCATION - Static variable in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
Deprecated.
since 12.18.0
PN_LOOP - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_MAP - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the resource property that defines areas of an image map.
PN_MAX_ITEMS - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the optional resource property that sets the query limit for the number of results to return.
PN_MODEL_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Path of the model resource.
PN_MUTE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_NAME - Static variable in interface com.adobe.cq.wcm.core.components.models.form.Field
Name of the property which holds the name of the field.
PN_NAVIGATION_ROOT - Static variable in interface com.adobe.cq.wcm.core.components.models.LanguageNavigation
Name of the resource / configuration policy property that defines the navigation root from which to build the global language structure navigation.
PN_NAVIGATION_ROOT - Static variable in interface com.adobe.cq.wcm.core.components.models.Navigation
Name of the resource / configuration policy property that defines the site's navigation root for which to build the navigation tree.
PN_ORDER_BY - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the optional resource property that stores the model element the list is sorted by.
PN_ORDER_BY - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property indicating by which criterion the sort is performed.
PN_PAGES - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property storing the list of pages to be rendered if the source of the list is static.
PN_PARENT_PAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property storing the root page from which to build the list if the source of the list is children.
PN_PARENT_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the optional resource property that stores the parent path of the content fragments.
PN_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Name of the mandatory resource property that stores the path to a content fragment.
PN_PLAYS_INLINE - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_PREFIX_PATH - Static variable in annotation type com.adobe.cq.wcm.core.components.config.HtmlPageItemsConfig
Name of the property that stores the path that will be prefixed to all href's and src's
PN_PRETITLE_HIDDEN - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not the pretitle is hidden.
PN_PWA_ENABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.PWA
Name of the property that defines if PWA is enabled for the website.
PN_PWA_ICON_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.PWA
Name of the property that defines the PWA icon
PN_PWA_START_URL - Static variable in interface com.adobe.cq.wcm.core.components.models.PWA
Name of the property that defines the start URL of this PWA
PN_PWA_THEME_COLOR - Static variable in interface com.adobe.cq.wcm.core.components.models.PWA
Name of the property that defines the theme color used.
PN_REL - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
 
PN_RESTRICT_LIST_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the configuration policy property that controls whether the author should be able to choose the list type or not.
PN_RESTRICT_START_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the configuration policy property that controls whether the author should be able to choose the minimum title level to report in the table of contents.
PN_RESTRICT_STOP_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the configuration policy property that controls whether the author should be able to choose the maximum title level to report in the table of contents.
PN_RESULTS_SIZE - Static variable in interface com.adobe.cq.wcm.core.components.models.Search
Name of the configuration policy property that defines the maximal number of results fetched by a search request.
PN_SEARCH_IN - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property storing where a search should be performed if the source of the list is search.
PN_SEARCH_ROOT - Static variable in interface com.adobe.cq.wcm.core.components.models.Search
Name of the resource / configuration policy property that defines the site's search root from which to search.
PN_SEARCH_TERM_MINIMUM_LENGTH - Static variable in interface com.adobe.cq.wcm.core.components.models.Search
Name of the configuration policy property that defines the minimum length of the search term to start the search.
PN_SHOW_ANNOTATION_TOOLS - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to enable annotation tools
PN_SHOW_DESCRIPTION - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the boolean resource property indicating if the list items should render a description.
PN_SHOW_DOWNLOAD_PDF - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to show download button
PN_SHOW_FULL_SCREEN - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to show full screen button
PN_SHOW_HIDDEN - Static variable in interface com.adobe.cq.wcm.core.components.models.Breadcrumb
Name of the resource property that will indicate if pages that are hidden for navigation will still be displayed.
PN_SHOW_LEFT_HAND_PANEL - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to display left side panel
PN_SHOW_MODIFICATION_DATE - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the boolean resource property indicating if the list items should render the modification date of each item.
PN_SHOW_PAGE_CONTROLS - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to show page controls
PN_SHOW_PRINT_PDF - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Set to true to show print button
PN_SHOW_TITLE_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not the title type is shown.
PN_SKIP_NAVIGATION_ROOT - Static variable in interface com.adobe.cq.wcm.core.components.models.Navigation
Deprecated.
since 12.11.0
PN_SOCIAL_MEDIA - Static variable in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
PN_SORT_ORDER - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the optional resource property that sets the sort order of the list (ascending / descending).
PN_SORT_ORDER - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property indicating how the list items should be sorted.
PN_SOURCE - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property indicating how the list will be built.
PN_SRC - Static variable in interface com.adobe.cq.wcm.core.components.models.HtmlPageItem
SRC attribute for HtmlPageItem.Element.SCRIPT page items
PN_START_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.Breadcrumb
Name of the resource property that will indicate from which level starting from the current page the items from the collection returned by Breadcrumb.getItems() will be accumulated.
PN_START_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the optional resource property that stores the minimum title level to generate table of contents.
PN_STOP_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
Name of the optional resource property that stores the maximum title level to generate table of contents.
PN_STRUCTURE_DEPTH - Static variable in interface com.adobe.cq.wcm.core.components.models.LanguageNavigation
Name of the resource / configuration policy property that defines the depth of the global language structure in the content tree relative to the site root.
PN_STRUCTURE_DEPTH - Static variable in interface com.adobe.cq.wcm.core.components.models.Navigation
Name of the resource / configuration policy property that defines the navigation structure depth, relative to the Navigation.PN_NAVIGATION_ROOT, where items will be searched for building the navigation tree.
PN_STRUCTURE_START - Static variable in interface com.adobe.cq.wcm.core.components.models.Navigation
Name of the resource / configuration policy property that defines the start level of navigation, relative to the Navigation.PN_NAVIGATION_ROOT, from which to start building the tree.
PN_TAG_NAMES - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragmentList
Name of the optional resource property that stores the tag names for filtering the result.
PN_TAGS - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property storing the tags that will be used for building the list if the source of the list is tags.
PN_TAGS_MATCH - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property indicating if the matching against tags can accept any tag from the tag list.
PN_TAGS_PARENT_PAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the resource property storing the root from where the tag search is performed.
PN_TEASER_DELEGATE - Static variable in interface com.adobe.cq.wcm.core.components.models.List
Name of the component property indicating to which teaser component the list items should be delegated.
PN_TITLE_FROM_ASSET - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the resource property that defines whether or not the title value is taken from the configured asset.
PN_TITLE_FROM_PAGE - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the resource property that defines whether or not the title value is taken from the linked page.
PN_TITLE_HIDDEN - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not the title is hidden.
PN_TITLE_LINK_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Title
Name of the policy property that defines whether or not the title link is disabled.
PN_TITLE_LINK_HIDDEN - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that defines whether or not the title link is hidden.
PN_TITLE_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.Download
Name of the policy property that stores the value for this title's HTML element type.
PN_TITLE_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.Teaser
Name of the policy property that stores the value for this title's HTML element type.
PN_TITLE_VALUE_FROM_DAM - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the configuration policy property that will indicate if the value of the title attribute should be populated from DAM if the component is configured with a file reference.
PN_TOUCH_ICON_120 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Key for the touch-enabled 120px square favicon file.
PN_TOUCH_ICON_152 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Key for the touch-enabled 152px square favicon file.
PN_TOUCH_ICON_60 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Key for the touch-enabled 60px square favicon file.
PN_TOUCH_ICON_76 - Static variable in interface com.adobe.cq.wcm.core.components.models.Page
Key for the touch-enabled 76px square favicon file.
PN_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the resource property that defines the embed input Embed.Type.
PN_URL - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Name of the resource property that defines the URL of an embeddable item.
PN_UUID_DISABLED - Static variable in interface com.adobe.cq.wcm.core.components.models.Image
Name of the policy property that defines whether or not the UUID is disabled.
PN_VARIANT_PATH - Static variable in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
PN_VARIATION_NAME - Static variable in interface com.adobe.cq.wcm.core.components.models.contentfragment.ContentFragment
Name of the optional resource property that stores the name of the variation to be used.
PN_VIDEO_ID - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
Name of the resource property that defines the id of the YouTube video.
PN_WIDTH - Static variable in interface com.adobe.cq.wcm.core.components.models.embeddable.YouTube
Name of the resource property that defines the width of the iFrame hosting the YouTube video.
process(String) - Method in interface com.adobe.cq.wcm.core.components.services.embed.UrlProcessor
Returns the result of processing the given URL, null if processing is not possible or failed.
processHtmlAttributes(String, Map<String, String>) - Method in interface com.adobe.cq.wcm.core.components.services.link.PathProcessor
Processes the HTML attributes for the LinkHandler
ProgressBar - Interface in com.adobe.cq.wcm.core.components.models
 
PV_FACEBOOK - Static variable in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
PV_PINTEREST - Static variable in interface com.adobe.cq.wcm.core.components.models.SocialMediaHelper
Deprecated.
PWA - Interface in com.adobe.cq.wcm.core.components.models
Interface for reading progressive web apps configuration

R

request - Variable in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
The current request.
resource - Variable in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
The current resource.
RT_EMBEDDABLE_V1 - Static variable in interface com.adobe.cq.wcm.core.components.models.Embed
Resource type of an embeddable.

S

sanitize(String, SlingHttpServletRequest) - Method in interface com.adobe.cq.wcm.core.components.services.link.PathProcessor
Sanitizes the given path by doing proper escaping and prepends the context path if needed.
Search - Interface in com.adobe.cq.wcm.core.components.models
Defines the Search Sling Model used for the /apps/core/wcm/components/search component.
Separator - Interface in com.adobe.cq.wcm.core.components.models
Defines the Separator Sling Model used for the /apps/core/wcm/components/separator component.
serialize(ComponentData, JsonGenerator, SerializerProvider) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.jackson.ComponentDataModelSerializer
 
setCurrentPage(Page) - Method in class com.adobe.cq.wcm.core.components.util.AbstractComponentImpl
Setter for current page.
showDescription() - Method in interface com.adobe.cq.wcm.core.components.models.List
Returns true if the list's items should render their description.
showModificationDate() - Method in interface com.adobe.cq.wcm.core.components.models.List
Returns true if the list's items should render their last modification date.
SIZED_CONTAINER - Static variable in interface com.adobe.cq.wcm.core.components.models.PdfViewer
Show PDF in a sized container
SMARTTAG_CONFIDENCE_PROP - Static variable in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Name of the property holding the confidence of smart tag;
SMARTTAG_NAME_PROP - Static variable in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Name of the property holding the name of smart tag;
SocialMediaHelper - Interface in com.adobe.cq.wcm.core.components.models
Deprecated.
The Social Media Sharing component is deprecated since Core Components 2.18.0 and should not be used in new projects.

T

TableOfContents - Interface in com.adobe.cq.wcm.core.components.models
 
TableOfContents.HeadingLevel - Enum in com.adobe.cq.wcm.core.components.models
Defines the possible heading levels for table of contents corresponding to 'h1' till 'h6'
TableOfContents.ListType - Enum in com.adobe.cq.wcm.core.components.models
Defines the possible list types for table of contents
Tabs - Interface in com.adobe.cq.wcm.core.components.models
Defines the Tabs Sling Model used for the /apps/core/wcm/components/tabs component.
Teaser - Interface in com.adobe.cq.wcm.core.components.models
Defines the Teaser Sling Model for the /apps/core/wcm/components/teaser component.
Text - Interface in com.adobe.cq.wcm.core.components.models.form
Defines the form Text Sling Model used for the /apps/core/wcm/components/form/text component.
Text - Interface in com.adobe.cq.wcm.core.components.models
Defines the Text Sling Model used for the /apps/core/wcm/components/text component.
title - Variable in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 
Title - Interface in com.adobe.cq.wcm.core.components.models
Defines the Title Sling Model used for the /apps/core/wcm/components/title component.
TOC_CONTENT_CLASS - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML class name added on the final TOC render.
TOC_DATA_ATTR_IGNORE_CLASSES - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML data attribute added on the TOC placeholder containing the configured ignore classes of the TOC as a comma separated list.
TOC_DATA_ATTR_INCLUDE_CLASSES - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML data attribute added on the TOC placeholder containing the configured include classes of the TOC as a comma separated list.
TOC_DATA_ATTR_LIST_TYPE - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML data attribute added on the TOC placeholder containing the configured list type of the TOC .
TOC_DATA_ATTR_START_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML data attribute added on the TOC placeholder containing the configured start level of the TOC.
TOC_DATA_ATTR_STOP_LEVEL - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML data attribute added on the TOC placeholder containing the configured stop level of the TOC.
TOC_PLACEHOLDER_CLASS - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML class name added on the TOC placeholder rendered by the component's HTL.
TOC_TEMPLATE_PLACEHOLDER_CLASS - Static variable in interface com.adobe.cq.wcm.core.components.models.TableOfContents
HTML class name added on the TOC template placeholder which is only viewed in EDIT mode on page editor.
toString() - Method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Element
 
toString() - Method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Location
 

U

UrlProcessor - Interface in com.adobe.cq.wcm.core.components.services.embed
Interface that defines a generic processor for a given URL.
UrlProcessor.Result - Interface in com.adobe.cq.wcm.core.components.services.embed
 

V

value - Variable in class com.adobe.cq.wcm.core.components.commons.editor.dialog.childreneditor.Item
 
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.Embed.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.form.Button.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.form.Options.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Element
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Location
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.LayoutContainer.LayoutType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.ListType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.Embed.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.form.Button.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.form.Options.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Element
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.HtmlPageItem.Location
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.LayoutContainer.LayoutType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.models.TableOfContents.ListType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.cq.wcm.core.components.services.embed.OEmbedResponse.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

withAssetData(Supplier<AssetData>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ImageComponentDataBuilder
Set the supplier that supplies the component's asset data.
withElementsData(Supplier<ContentFragmentData.ElementData[]>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ContentFragmentDataBuilder
Set the supplier that supplies the content fragment data.
withEmbeddableDetails(Supplier<Map<String, Object>>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.EmbeddableDataBuilder
Sets the supplier that supplies the content fragment data.
withFormat(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Sets the supplier that supplies the Asset's format.
withId(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.GenericDataBuilder
Set the supplier that supplies the component's ID.
withId(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.IdRequiredDataBuilder
Set the supplier that supplies the component's ID.
withLanguage(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.PageDataBuilder
Set the supplier that supplies the page's language data.
withLastModifiedDate(Supplier<Date>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Set the supplier that supplies the component's last modified date.
withShownItems(Supplier<String[]>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.ContainerDataBuilder
Set the supplier that supplies the array of shown items.
withSmartTags(Supplier<Map<String, Object>>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Sets the supplier that supplies the Asset's smart tags.
withTags(Supplier<String[]>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Sets the supplier that supplies the Asset's tags.
withTags(Supplier<String[]>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.PageDataBuilder
Set the supplier that supplies the page's tags data.
withTemplatePath(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.PageDataBuilder
Set the supplier that supplies the page's template path data.
withUrl(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.AssetDataBuilder
Sets the supplier that supplies the URL.
withUrl(Supplier<String>) - Method in class com.adobe.cq.wcm.core.components.models.datalayer.builder.PageDataBuilder
Set the supplier that supplies the page's URL data.

Y

YouTube - Interface in com.adobe.cq.wcm.core.components.models.embeddable
 
A B C D E F G H I J L M N O P R S T U V W Y 
Skip navigation links

Copyright © 2022. All rights reserved.