| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Carousel |
| Handler Class | None |
| Renderer Type | org.primefaces.component.CarouselRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Datasource of the component. |
var | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the iterator variable used to refer each data. |
firstVisible | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Index of the first visible item. |
numVisible | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of visible items per page. Default is 3. |
circular | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Sets continuous scrolling. Default is false. |
vertical | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Sets vertical scrolling. Default is false |
autoPlayInterval | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Sets the time in milliseconds to have Carousel start scrolling automatically after being initialized. Default is 0. |
pageLinks | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines number of pageLinks of paginator. |
effect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the animation effect slide or fade. Default is slide. |
easing | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the animation effect. Default is easeInOutCirc. |
effectDuration | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Sets the speed of the scrolling animation in milliseconds. Default is 500. |
dropdownTemplate | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text format of the pager dropdown elements. Default is "{page}". |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the main container. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container. |
itemStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of each item container. |
itemStyleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of each item container. |
headerText | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Shortcut for header facet. |
footerText | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Shortcut for footer facet. |
responsive | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In responsive mode, carousel adjusts its content based on screen size. |
breakpoint | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Breakpoint value in pixels to switch between small and large viewport. Default is 640 |
toggleable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Makes panel toggleable. Default is false. |
toggleSpeed | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Speed of toggling in milliseconds. Default is 500 |
collapsed | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Renders a toggleable panel as collapsed. Default is false. |
stateful | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, carousel state is saved in a cookie for the session. Default is false. |
Output generated by Vdldoc View Declaration Language Documentation Generator.