Options
All
  • Public
  • Public/Protected
  • All
Menu

PrimeFaces Carousel Widget Carousel is a content slider featuring various customization options.

Type parameters

Hierarchy

Index

Constructors

constructor

  • Creates a new instance of this widget. Please note that you should NOT override this constructor. Instead, override the init method, which is called at the end of the constructor once the instance is created.

    Type parameters

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns Carousel<TCfg>

Properties

allowAutoplay

allowAutoplay: boolean

Whether autoplay is allowed or not.

carouselStyle

carouselStyle: HTMLStyleElement

Style element with the custom CSS for the carousel.

cfg

cfg: PartialWidgetCfg<TCfg>

The configuration of this widget instance. Please note that no property is guaranteed to be present, you should always check for undefined before accessing a property. This is partly because the value of a property is not transmitted from the server to the client when it equals the default.

circular

circular: boolean

Whether the viewport is circular or not.

container

container: JQuery<HTMLElement>

The DOM element for the container of the carousel that contains items container and buttons.

content

The DOM element for the content of the carousel that shows the carousel.

destroyListeners

Array of registered listeners invoked when this widget is destroyed. You should normally not use modify this directly, use addDestroyListener instead.

documentResizeListener

documentResizeListener: undefined | ((event: UIEvent) => void)

Callback used to listen to resize events and adjust the carousel accordingly.

id

id: string | string[]

The client-side ID of this widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

Optional indicators

indicators?: JQuery<HTMLElement>

DOM elements of the LI indicator of the carousel.

indicatorsContainer

indicatorsContainer: JQuery<HTMLElement>

The DOM element for the indicators container of the carousel.

Optional interval

interval?: number

Timeout ID of the timer used for autoplay.

isAutoplay

isAutoplay: boolean

Whether autoplay is allowed or not.

isCircular

isCircular: boolean

Whether the circular mode is on or not.

isRemainingItemsAdded

isRemainingItemsAdded: boolean

Whether the remaining items have been added or not.

isVertical

isVertical: boolean

Whether the viewport is vertical or not.

items

The DOM elements for the carousel items.

itemsContainer

itemsContainer: JQuery<HTMLElement>

The DOM element for the item container of the carousel.

itemsContent

itemsContent: JQuery<HTMLElement>

The DOM element for the item container of the carousel.

itemsCount

itemsCount: number

The number of simultaneously visible items.

jq

The jQuery instance of the container element of this widget. In case id is an array, it will contain multiple elements. Please note that some widgets have got not DOM elements at all, in this case this will be an empty jQuery instance.

jqId

jqId: string

A CSS selector for the container element (or elements, in case id is an array) of this widget, This is usually an ID selector (that is properly escaped). You can select the container element or elements like this: $(widget.jqId).

nextNav

The DOM element for the button to switch to the previous carousel item.

numScroll

numScroll: number

Instant number of how many items will scroll when scrolled.

numVisible

numVisible: number

Instant number of items visible on the carousel viewport.

oldNumScroll

oldNumScroll: number

Old number of items visible on the carousel viewport.

oldNumVisible

oldNumVisible: number

Old number of how many items will scroll when scrolled.

page

page: number

The currently displayed page of carousel items.

prevNav

The DOM element for the button to switch to the next carousel item.

refreshListeners

Array of registered listeners invoked when this widget is refreshed. You should normally not use modify this directly, use addRefreshListener instead.

remainingItems

remainingItems: number

How many items remaining for the show.

totalIndicators

totalIndicators: number

The number of indicators currently in the viewport.

totalShiftedItems

totalShiftedItems: number

The number of how many items shifted.

widgetVar

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF('myWidgetVar').

Methods

Protected _render

  • _render(): void
  • This render method is called by this deferred widget once the widget container has become visible. You may now proceed with widget initialization.

    Must be overridden, or an error will be thrown.

    override

    Returns void

Protected addDeferredRender

  • addDeferredRender(widgetId: string, container: JQuery<HTMLElement>, callback: () => boolean): void
  • Adds a deferred rendering task for the given widget to the queue.

    Parameters

    • widgetId: string

      The ID of a deferred widget.

    • container: JQuery<HTMLElement>

      The container element that should be visible.

    • callback: () => boolean

      Callback that is invoked when the widget may possibly have become visible. Should return true when the widget was rendered, or false when the widget still needs to be rendered later.

        • (): boolean
        • Returns boolean

    Returns void

addDestroyListener

  • Lets you register a listener that is called before the component is destroyed.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and all destroy listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the destroy method; or if you do, call super.

    Also, after this widget was detached is done, all destroy listeners will be unregistered.

    since

    7.0

    Parameters

    Returns void

addRefreshListener

  • When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, all refresh listeners are called. This makes it possible to add listeners from outside the widget code.

    If you call this method twice with the same listener, it will be registered twice and later also called twice.

    Note that for this to work, you must not override the refresh method; or if you do, call super.

    Also, after the refresh is done, all refresh listeners will be deregistered. If you added the listeners from within this widget, consider adding the refresh listeners not only in the init method, but also again in the refresh method after calling super.

    since

    7.0.0

    Parameters

    Returns void

Private backwardIsDisabled

  • backwardIsDisabled(): boolean
  • Retrieves whether the backward button is disabled.

    Returns boolean

    backward button is disabled.

Private bindDocumentListeners

  • bindDocumentListeners(): void
  • Adds the resize event listener to the window.

    Returns void

Private bindEvents

  • bindEvents(): void
  • Sets up all event listeners required by this widget.

    Returns void

Private calculatePosition

  • calculatePosition(): void
  • Calculates position and visible items and the number of how many items will be scrolled when screen aspect ratio changes then updates current page of the current Carousel widget.

    Returns void

callBehavior

  • Each widget may have one or several behaviors attached to it. This method calls all attached behaviors for the given event name. In case no such behavior exists, this method does nothing and returns immediately.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    since

    7.0

    Parameters

    • event: string

      The name of an event to call.

    • Optional ext: Partial<ConfigurationExtender>

      Additional configuration that is passed to the AJAX request for the server-side callback.

    Returns void

Private changePosition

  • changePosition(totalShiftedItems: number): void
  • Scrolls the item container based on the total number of shifted items

    Parameters

    • totalShiftedItems: number

      total number of shifted items.

    Returns void

Private cloneItems

  • cloneItems(): void
  • Clones items if the carousel widget is circular

    Returns void

Private createStyle

  • createStyle(): void
  • Creates responsive styles of the carousel container.

    Returns void

destroy

  • destroy(): void
  • Cleans up deferred render tasks. When you extend this class and override this method, make sure to call super.

    override

    Returns void

Private firstIndex

  • firstIndex(): number
  • Retrieves the first index of visible items.

    Returns number

    first index of the visible items.

Private forwardIsDisabled

  • forwardIsDisabled(): boolean
  • Retrieves whether the forward button is disabled.

    Returns boolean

    forward button is disabled.

getBehavior

  • getBehavior(name: string): null | Behavior
  • Each widget may have one or several behaviors attached to it. This method returns the callback function for the given event.

    Note: Do not call the method directly, the recommended way to invoke a behavior is via callBehavior.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • name: string

      The name of an event for which to retrieve the behavior.

    Returns null | Behavior

    The behavior with the given name, or null if no such behavior exists.

getJQ

  • Each widget has got a container element, this method returns that container. This container element is usually also the element whose ID is the client-side ID of the JSF component.

    Returns JQuery<HTMLElement>

    The jQuery instance representing the main HTML container element of this widget.

getParentForm

  • Gets the closest parent form for this widget.

    since

    10.0.0

    Returns JQuery<HTMLElement>

    A JQuery instance that either contains the form when found, or an empty JQuery instance when the form could not be found.

getParentFormId

  • getParentFormId(): undefined | string
  • Gets the closest parent form ID for this widget lazily so it can be used in AJAX requests.

    since

    10.0.0

    Returns undefined | string

    Either the form ID or undefined if no form can be found.

Private getTotalIndicators

  • getTotalIndicators(): number
  • Retrieves the total number of the indicators.

    Returns number

    total number of the indicators.

hasBehavior

  • hasBehavior(event: string): boolean
  • Each widget may have one or several behaviors attached to it. This method checks whether this widget has got at least one behavior associated with given event name.

    A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.

    Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server and processes the response once it is received. This enables several features such as updating or replacing elements dynamically. You can add an AJAX behavior via <p:ajax event="name" actionListener="#{...}" onstart="..." />.

    Parameters

    • event: string

      The name of an event to check.

    Returns boolean

    true if this widget has the given behavior, false otherwise.

init

  • A widget class should not declare an explicit constructor, the default constructor provided by this base widget should be used. Instead, override this initialize method which is called after the widget instance was constructed. You can use this method to perform any initialization that is required. For widgets that need to create custom HTML on the client-side this is also the place where you should call your render method.

    Please make sure to call the super method first before adding your own custom logic to the init method:

    PrimeFaces.widget.MyWidget = PrimeFaces.widget.BaseWidget.extend({
    init: function(cfg) {
    this._super(cfg);
    // custom initialization
    }
    });
    override

    Parameters

    • cfg: PartialWidgetCfg<TCfg>

      The widget configuration to be used for this widget instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for this component.

    Returns void

Private initPageState

  • initPageState(): void
  • Initialize current page and variables.

    Returns void

isDetached

  • isDetached(): boolean
  • Checks if this widget is detached, ie whether the HTML element of this widget is currently contained within the DOM (the HTML body element). A widget may become detached during an AJAX update, and it may remain detached in case the update removed this component from the component tree.

    Returns boolean

    true if this widget is currently detached, or false otherwise.

Private lastIndex

  • lastIndex(): number
  • Retrieves the last index of visible items.

    Returns number

    last index of the visible items.

navBackward

  • navBackward(event: Event, index: number): void
  • Moves this carousel to the previous page. If autoplay is active, it will stop.

    Parameters

    • event: Event

      Event that occurred.

    • index: number

      0-based index of the page to display.

    Returns void

navForward

  • navForward(event: Event, index: number): void
  • Moves this carousel to the next page. If autoplay is active, it will stop.

    Parameters

    • event: Event

      Event that occurred.

    • index: number

      0-based index of the page to display.

    Returns void

Private onIndicatorClick

  • onIndicatorClick(event: Event, index: number): void
  • It moves the current Carousel to the index of the clicked indicator on that Carousel viewport.

    Parameters

    • event: Event

      Event that occurred.

    • index: number

      0-based index of the indicator.

    Returns void

Private onTransitionEnd

  • onTransitionEnd(): void
  • Changes current page according to the state of the page when the transition ends.

    Returns void

Protected postRender

  • postRender(): void
  • Called after the widget has become visible and after it was rendered. May be overridden, the default implementation is a no-op.

    Returns void

refresh

  • Used in ajax updates, reloads the widget configuration.

    When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, this method is called with the new widget configuration from the server. This makes it possible to persist client-side state during an update, such as the currently selected tab.

    Please note that instead of overriding this method, you should consider adding a refresh listener instead via addRefreshListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.

    By default, this method calls all refresh listeners, then reinitializes the widget by calling the init method.

    override

    Parameters

    Returns void

    The value as returned by the init method, which is often undefined.

removeScriptElement

  • removeScriptElement(clientId: string | string[]): void
  • Removes the widget's script block from the DOM. Currently, the ID of this script block consists of the client-side ID of this widget with the prefix _s, but this is subject to change.

    Parameters

    • clientId: string | string[]

      The client-side ID of the widget.

    Returns void

render

  • This render method to check whether the widget container is visible. Do not override this method, or the deferred widget functionality may not work properly anymore.

    Returns ReturnOrVoid<undefined | boolean>

    true if the widget container is visible, false or undefined otherwise.

renderDeferred

  • renderDeferred(): void
  • Call this method in the init method if you want deferred rendering support. This method checks whether the container of this widget is visible and call _render only once it is.

    Returns void

Private renderIndicators

  • renderIndicators(): string
  • Retrieves the indicators html of the carousel.

    Returns string

    html of the indicators container.

startAutoplay

  • startAutoplay(): void
  • Enables autoplay and starts the slideshow.

    Returns void

step

  • step(dir: number, page: number): void
  • Moves this carousel to the given page.

    Parameters

    • dir: number

      direction of the move and takes a value of -1 or 1.

    • page: number

      0-based index of the page to display.

    Returns void

stopAutoplay

  • stopAutoplay(): void
  • Disables autoplay and stops the slideshow.

    Returns void

Private styleActiveItems

  • styleActiveItems(): void
  • Styles visible items

    Returns void

Private styleClone

  • Applies styles to the clones

    Parameters

    • element: JQuery<HTMLElement>

      cloned dom element of the item

    • index: number

      index of the element

    • length: number

      length of the clones

    Returns void

Private updateIndicators

  • updateIndicators(): void
  • Render the indicators based on the current page state.

    Returns void

Private updateNavigators

  • updateNavigators(): void
  • Update styles of the navigator buttons.

    Returns void

Private updatePage

  • updatePage(): void
  • Updates the current page of the carousel.

    Returns void

Generated using TypeDoc