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.TransientStateHolder, 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

protected static class

Carousel.PropertyKeys

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTAINER_CLASS
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	PAGE_LINK_CLASS
static String	PAGE_LINKS_CONTAINER_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

PAGINATOR_ACTIVE_PAGE_CLASS, PAGINATOR_BOTTOM_CONTAINER_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_OPTIONS_CLASS, PAGINATOR_TOP_CONTAINER_CLASS

Fields inherited from class javax.faces.component.UIComponent

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Carousel()

Method Summary

int	getAutoPlayInterval()
String	getDropdownTemplate()
String	getEasing()
String	getEffect()
int	getEffectDuration()
protected javax.faces.context.FacesContext	getFacesContext()
String	getFamily()
int	getFirstVisible()
String	getFooterText()
String	getHeaderText()
String	getItemStyle()
String	getItemStyleClass()
int	getPageLinks()
int	getRenderedChildCount()
String	getStyle()
String	getStyleClass()
String	getWidgetVar()
void	handleAttribute(String name, Object value)
boolean	isCircular()
boolean	isVertical()
void	processDecodes(javax.faces.context.FacesContext facesContext) Following three overrides enables processing of all items
void	processUpdates(javax.faces.context.FacesContext facesContext)
void	processValidators(javax.faces.context.FacesContext facesContext)
String	resolveWidgetVar()
void	setAutoPlayInterval(int _autoPlayInterval)
void	setCircular(boolean _circular)
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	setPageLinks(int _pageLinks)
void	setStyle(String _style)
void	setStyleClass(String _styleClass)
void	setVertical(boolean _vertical)
void	setWidgetVar(String _widgetVar)

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

calculatePage, getClientId, getContainerClientId, getCurrentPageReportTemplate, getDataModel, getPage, getPageCount, getPaginatorPosition, getPaginatorTemplate, getRowIndex, getRowIndexVar, getRowsPerPageTemplate, getRowsToRender, isLazy, isPaginationRequest, isPaginator, isPaginatorAlwaysVisible, process, processChildren, processChildrenFacets, processFacets, processPhase, restoreDescendantState, restoreDescendantState, saveDescendantState, saveDescendantState, setCurrentPageReportTemplate, setDataModel, setId, setLazy, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setRowIndex, setRowIndexVar, setRowModel, setRowsPerPageTemplate, shouldProcessChildren, shouldVisitChildren, shouldVisitRows, updatePaginationData, visitChildrenFacets, visitFacets, visitRows, visitTree

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, encodeBegin, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, queueEvent, restoreState, saveState, setFirst, setFooter, setHeader, setRows, setRowStatePreserved, 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, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

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

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

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)

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)

getRenderedChildCount

public int getRenderedChildCount()

getFirstVisible

public int getFirstVisible()

setFirstVisible

public void setFirstVisible(int _firstVisible)

processDecodes

public void processDecodes(javax.faces.context.FacesContext facesContext)

Following three overrides enables processing of all items

Overrides:

processDecodes in class UIData

processValidators

public void processValidators(javax.faces.context.FacesContext facesContext)

Overrides:

processValidators in class UIData

processUpdates

public void processUpdates(javax.faces.context.FacesContext facesContext)

Overrides:

processUpdates in class UIData

getFacesContext

protected javax.faces.context.FacesContext getFacesContext()

Overrides:

getFacesContext in class javax.faces.component.UIComponentBase

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget

handleAttribute

public void handleAttribute(String name,
                            Object value)