Interface Carousel
-
- All Superinterfaces:
Component
,ComponentExporter
,Container
,ContainerExporter
,PanelContainer
@ConsumerType public interface Carousel extends PanelContainer
Defines theCarousel
Sling Model used for the/apps/core/wcm/components/carousel
component.- Since:
- com.adobe.cq.wcm.core.components.models 12.5.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PN_ACTIVE_ITEM
Name of the resource property that indicates the name of the Carousel item which is shown by default in the component.static java.lang.String
PN_AUTOPAUSE_DISABLED
Name of the resource property that indicates whether automatic pause on hovering the carousel is disabled, or not.static java.lang.String
PN_AUTOPLAY
Name of the resource property that indicates whether to automatically transition between slides, or not.static java.lang.String
PN_CONTROLS_PREPENDED
Name of the policy property that defines whether the control elements should be placed in front of the carousel items.static java.lang.String
PN_DELAY
Name of the resource property that indicates the delay (in milliseconds) when automatically transitioning between slides.-
Fields inherited from interface com.adobe.cq.wcm.core.components.models.Container
PN_BACKGROUND_COLOR, PN_BACKGROUND_COLOR_ENABLED, PN_BACKGROUND_COLOR_SWATCHES_ONLY, PN_BACKGROUND_IMAGE_ENABLED, PN_BACKGROUND_IMAGE_REFERENCE
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default boolean
getAccessibilityAutoItemTitles()
Returns an accessibility label that describes the carousel.default java.lang.String
getAccessibilityLabel()
Returns an accessibility label that describes the carousel.default java.lang.String
getAccessibilityNext()
Returns an accessibility label that describes the carousel.default java.lang.String
getAccessibilityPause()
Returns an accessibility label that describes the carousel.default java.lang.String
getAccessibilityPlay()
Returns an accessibility label that describes the carousel.default java.lang.String
getAccessibilityPrevious()
Returns an accessibility label that describes the carousel.default java.lang.String
getAccessibilityTablist()
Returns an accessibility label that describes the carousel.default java.lang.String
getActiveItem()
Returns the name of the default active item as defined by thePN_ACTIVE_ITEM
property.default boolean
getAutopauseDisabled()
Indicates whether automatic pause on hovering the carousel is disabled, or not.default boolean
getAutoplay()
Indicates whether the carousel should automatically transition between slides or not.default java.lang.Long
getDelay()
Returns the delay (in milliseconds) when automatically transitioning between slides.default boolean
isControlsPrepended()
Checks if the control elements should be placed in front of the carousel items.-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getExportedType, getId
-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Container
getBackgroundStyle, getExportedItems, getExportedItemsOrder, getItems
-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.PanelContainer
getChildren
-
-
-
-
Field Detail
-
PN_AUTOPLAY
static final java.lang.String PN_AUTOPLAY
Name of the resource property that indicates whether to automatically transition between slides, or not.- Since:
- com.adobe.cq.wcm.core.components.models 12.5.0
- See Also:
- Constant Field Values
-
PN_DELAY
static final java.lang.String PN_DELAY
Name of the resource property that indicates the delay (in milliseconds) when automatically transitioning between slides.- Since:
- com.adobe.cq.wcm.core.components.models 12.5.0
- See Also:
- Constant Field Values
-
PN_AUTOPAUSE_DISABLED
static final java.lang.String PN_AUTOPAUSE_DISABLED
Name of the resource property that indicates whether automatic pause on hovering the carousel is disabled, or not.- Since:
- com.adobe.cq.wcm.core.components.models 12.6.0
- See Also:
- Constant Field Values
-
PN_ACTIVE_ITEM
static final java.lang.String PN_ACTIVE_ITEM
Name of the resource property that indicates the name of the Carousel item which is shown by default in the component.- Since:
- com.adobe.cq.wcm.core.components.models 12.27.0
- See Also:
- Constant Field Values
-
PN_CONTROLS_PREPENDED
static final java.lang.String PN_CONTROLS_PREPENDED
Name of the policy property that defines whether the control elements should be placed in front of the carousel items.- Since:
- com.adobe.cq.wcm.core.components.models 12.20.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAutoplay
default boolean getAutoplay()
Indicates whether the carousel should automatically transition between slides or not.- Returns:
true
if the carousel should automatically transition slides;false
otherwise- Since:
- com.adobe.cq.wcm.core.components.models 12.5.0
-
getDelay
default java.lang.Long getDelay()
Returns the delay (in milliseconds) when automatically transitioning between slides.- Returns:
- the delay (in milliseconds) when automatically transitioning between slides
- Since:
- com.adobe.cq.wcm.core.components.models 12.5.0
-
getAutopauseDisabled
default boolean getAutopauseDisabled()
Indicates whether automatic pause on hovering the carousel is disabled, or not.- Returns:
true
if automatic pause on hovering the carousel should be disabled;false
otherwise- Since:
- com.adobe.cq.wcm.core.components.models 12.6.0
-
getAccessibilityLabel
default java.lang.String getAccessibilityLabel()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
getAccessibilityPrevious
default java.lang.String getAccessibilityPrevious()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
getAccessibilityNext
default java.lang.String getAccessibilityNext()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
getAccessibilityPlay
default java.lang.String getAccessibilityPlay()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
getAccessibilityPause
default java.lang.String getAccessibilityPause()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
getAccessibilityTablist
default java.lang.String getAccessibilityTablist()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
getAccessibilityAutoItemTitles
default boolean getAccessibilityAutoItemTitles()
Returns an accessibility label that describes the carousel.- Returns:
- an accessibility label for the carousel
- Since:
- com.adobe.cq.wcm.core.components.models 12.9.0
-
isControlsPrepended
default boolean isControlsPrepended()
Checks if the control elements should be placed in front of the carousel items.- Returns:
true
if the control elements should be placed in front of the items,false
if they should be appended- Since:
- com.adobe.cq.wcm.core.components.models 12.20.0
-
getActiveItem
default java.lang.String getActiveItem()
Returns the name of the default active item as defined by thePN_ACTIVE_ITEM
property. If the property is missing then the name of the first item is returned.- Returns:
- the default active item name
- Since:
- com.adobe.cq.wcm.core.components.models 12.27.0
-
-