org.primefaces.component.carousel

Class Carousel

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.primefaces.component.api.UIData

org.primefaces.component.carousel.Carousel

All Implemented Interfaces:

EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Widget

public class Carousel
extends UIData
implements Widget

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Carousel.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTAINER_CLASS
static String	DEFAULT_RENDERER
static String	DROPDOWN_CLASS
static String	FOOTER_CLASS
static String	HEADER_CLASS
static String	HEADER_TITLE_CLASS
static String	HORIZONTAL_NEXT_BUTTON
static String	HORIZONTAL_PREV_BUTTON
static String	ITEM_CLASS
static String	ITEMS_CLASS
static String	MOBILE_DROPDOWN_CLASS
static String	PAGE_LINK_CLASS
static String	PAGE_LINKS_CONTAINER_CLASS
static String	TOGGLER_LINK_CLASS
static String	VERTICAL_NEXT_BUTTON
static String	VERTICAL_PREV_BUTTON
static String	VERTICAL_VIEWPORT_CLASS
static String	VIEWPORT_CLASS

Fields inherited from class org.primefaces.component.api.UIData

ARIA_FIRST_PAGE_LABEL, ARIA_HEADER_LABEL, ARIA_LAST_PAGE_LABEL, ARIA_NEXT_PAGE_LABEL, ARIA_PREVIOUS_PAGE_LABEL, PAGINATOR_ACTIVE_PAGE_CLASS, PAGINATOR_BOTTOM_CONTAINER_CLASS, PAGINATOR_BOTTOM_LEFT_CONTENT_CLASS, PAGINATOR_BOTTOM_RIGHT_CONTENT_CLASS, PAGINATOR_CURRENT_CLASS, PAGINATOR_FIRST_PAGE_ICON_CLASS, PAGINATOR_FIRST_PAGE_LINK_CLASS, PAGINATOR_JTP_CLASS, PAGINATOR_LAST_PAGE_ICON_CLASS, PAGINATOR_LAST_PAGE_LINK_CLASS, PAGINATOR_NEXT_PAGE_ICON_CLASS, PAGINATOR_NEXT_PAGE_LINK_CLASS, PAGINATOR_PAGE_CLASS, PAGINATOR_PAGES_CLASS, PAGINATOR_PREV_PAGE_ICON_CLASS, PAGINATOR_PREV_PAGE_LINK_CLASS, PAGINATOR_RPP_LABEL_CLASS, PAGINATOR_RPP_OPTIONS_CLASS, PAGINATOR_TOP_CONTAINER_CLASS, PAGINATOR_TOP_LEFT_CONTENT_CLASS, PAGINATOR_TOP_RIGHT_CONTENT_CLASS, ROWS_PER_PAGE_LABEL

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
Carousel()

Method Summary

Modifier and Type	Method and Description
int	getAutoPlayInterval()
int	getBreakpoint()
String	getDropdownTemplate()
String	getEasing()
String	getEffect()
int	getEffectDuration()
String	getFamily()
int	getFirstVisible()
String	getFooterText()
String	getHeaderText()
String	getItemStyle()
String	getItemStyleClass()
int	getNumVisible()
int	getPageLinks()
int	getRenderedChildCount()
String	getStyle()
String	getStyleClass()
int	getToggleSpeed()
String	getWidgetVar()
boolean	isCircular()
boolean	isCollapsed()
boolean	isResponsive()
boolean	isStateful()
boolean	isToggleable()
boolean	isVertical()
String	resolveWidgetVar()
void	setAutoPlayInterval(int _autoPlayInterval)
void	setBreakpoint(int _breakpoint)
void	setCircular(boolean _circular)
void	setCollapsed(boolean _collapsed)
void	setDropdownTemplate(String _dropdownTemplate)
void	setEasing(String _easing)
void	setEffect(String _effect)
void	setEffectDuration(int _effectDuration)
void	setFirstVisible(int _firstVisible)
void	setFooterText(String _footerText)
void	setHeaderText(String _headerText)
void	setItemStyle(String _itemStyle)
void	setItemStyleClass(String _itemStyleClass)
void	setNumVisible(int _numVisible)
void	setPageLinks(int _pageLinks)
void	setResponsive(boolean _responsive)
void	setRows(int rows)
void	setStateful(boolean _stateful)
void	setStyle(String _style)
void	setStyleClass(String _styleClass)
void	setToggleable(boolean _toggleable)
void	setToggleSpeed(int _toggleSpeed)
void	setVertical(boolean _vertical)
void	setWidgetVar(String _widgetVar)

Methods inherited from class org.primefaces.component.api.UIData

calculateFirst, encodeBegin, getClientId, getContainerClientId, getCurrentPageReportTemplate, getDataModel, getIterableChildren, getPage, getPageCount, getPaginatorPosition, getPaginatorTemplate, getRowIndex, getRowIndexVar, getRowsPerPageLabel, getRowsPerPageTemplate, getRowsToRender, invokeOnComponent, isLazy, isNestedWithinIterator, isPaginationRequest, isPaginator, isPaginatorAlwaysVisible, isRowStatePreserved, markInitialState, preDecode, preEncode, preUpdate, preValidate, process, processChildren, processColumnFacets, processDecodes, processFacets, processPhase, processUpdates, processValidators, requiresColumns, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, saveState, setCurrentPageReportTemplate, setDataModel, setId, setLazy, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setRowIndex, setRowIndexVar, setRowModel, setRowsPerPageLabel, setRowsPerPageTemplate, setRowStatePreserved, shouldSkipChildren, shouldVisitChildren, shouldVisitRows, updatePaginationData, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, visitFacets, visitRows, visitTree

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getValue, getVar, isRowAvailable, queueEvent, setFirst, setFooter, setHeader, setValue, setValueBinding, setValueExpression, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

CONTAINER_CLASS

public static final String CONTAINER_CLASS

See Also:

Constant Field Values

ITEM_CLASS

public static final String ITEM_CLASS

See Also:

Constant Field Values

HEADER_CLASS

public static final String HEADER_CLASS

See Also:

Constant Field Values

HEADER_TITLE_CLASS

public static final String HEADER_TITLE_CLASS

See Also:

Constant Field Values

FOOTER_CLASS

public static final String FOOTER_CLASS

See Also:

Constant Field Values

HORIZONTAL_NEXT_BUTTON

public static final String HORIZONTAL_NEXT_BUTTON

See Also:

Constant Field Values

HORIZONTAL_PREV_BUTTON

public static final String HORIZONTAL_PREV_BUTTON

See Also:

Constant Field Values

VERTICAL_NEXT_BUTTON

public static final String VERTICAL_NEXT_BUTTON

See Also:

Constant Field Values

VERTICAL_PREV_BUTTON

public static final String VERTICAL_PREV_BUTTON

See Also:

Constant Field Values

VIEWPORT_CLASS

public static final String VIEWPORT_CLASS

See Also:

Constant Field Values

ITEMS_CLASS

public static final String ITEMS_CLASS

See Also:

Constant Field Values

VERTICAL_VIEWPORT_CLASS

public static final String VERTICAL_VIEWPORT_CLASS

See Also:

Constant Field Values

PAGE_LINKS_CONTAINER_CLASS

public static final String PAGE_LINKS_CONTAINER_CLASS

See Also:

Constant Field Values

PAGE_LINK_CLASS

public static final String PAGE_LINK_CLASS

See Also:

Constant Field Values

DROPDOWN_CLASS

public static final String DROPDOWN_CLASS

See Also:

Constant Field Values

MOBILE_DROPDOWN_CLASS

public static final String MOBILE_DROPDOWN_CLASS

See Also:

Constant Field Values

TOGGLER_LINK_CLASS

public static final String TOGGLER_LINK_CLASS

See Also:

Constant Field Values

Constructor Detail

Carousel

public Carousel()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String _widgetVar)

getFirstVisible

public int getFirstVisible()

setFirstVisible

public void setFirstVisible(int _firstVisible)

getNumVisible

public int getNumVisible()

setNumVisible

public void setNumVisible(int _numVisible)

isCircular

public boolean isCircular()

setCircular

public void setCircular(boolean _circular)

isVertical

public boolean isVertical()

setVertical

public void setVertical(boolean _vertical)

getAutoPlayInterval

public int getAutoPlayInterval()

setAutoPlayInterval

public void setAutoPlayInterval(int _autoPlayInterval)

getPageLinks

public int getPageLinks()

Overrides:

getPageLinks in class UIData

setPageLinks

public void setPageLinks(int _pageLinks)

Overrides:

setPageLinks in class UIData

getEffect

public String getEffect()

setEffect

public void setEffect(String _effect)

getEasing

public String getEasing()

setEasing

public void setEasing(String _easing)

getEffectDuration

public int getEffectDuration()

setEffectDuration

public void setEffectDuration(int _effectDuration)

getDropdownTemplate

public String getDropdownTemplate()

setDropdownTemplate

public void setDropdownTemplate(String _dropdownTemplate)

getStyle

public String getStyle()

setStyle

public void setStyle(String _style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String _styleClass)

getItemStyle

public String getItemStyle()

setItemStyle

public void setItemStyle(String _itemStyle)

getItemStyleClass

public String getItemStyleClass()

setItemStyleClass

public void setItemStyleClass(String _itemStyleClass)

getHeaderText

public String getHeaderText()

setHeaderText

public void setHeaderText(String _headerText)

getFooterText

public String getFooterText()

setFooterText

public void setFooterText(String _footerText)

isResponsive

public boolean isResponsive()

setResponsive

public void setResponsive(boolean _responsive)

getBreakpoint

public int getBreakpoint()

setBreakpoint

public void setBreakpoint(int _breakpoint)

isToggleable

public boolean isToggleable()

setToggleable

public void setToggleable(boolean _toggleable)

getToggleSpeed

public int getToggleSpeed()

setToggleSpeed

public void setToggleSpeed(int _toggleSpeed)

isCollapsed

public boolean isCollapsed()

setCollapsed

public void setCollapsed(boolean _collapsed)

isStateful

public boolean isStateful()

setStateful

public void setStateful(boolean _stateful)

getRenderedChildCount

public int getRenderedChildCount()

setRows

public void setRows(int rows)

Overrides:

setRows in class javax.faces.component.UIData

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget