Package org.primefaces.component.carousel

Class CarouselBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.primefaces.component.api.UITabPanel

org.primefaces.component.carousel.CarouselBase

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, PrimeClientBehaviorHolder, TouchAware, Widget

Direct Known Subclasses:

Carousel

public abstract class CarouselBase
extends UITabPanel
implements Widget, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder, TouchAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CarouselBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY
static final String	DEFAULT_RENDERER

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_TYPE

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

Fields inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder

DEFAULT_SELECT_EVENT_NAMES

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
CarouselBase()

Method Summary

Modifier and Type	Method	Description
int	getAutoplayInterval()
String	getContainerStyleClass()
String	getContentStyleClass()
String	getFamily()
String	getFooterText()
String	getHeaderText()
String	getIndicatorsContentStyleClass()
int	getNumScroll()
int	getNumVisible()
String	getOnPageChange()
String	getOrientation()
int	getPage()
List<ResponsiveOption>	getResponsiveOptions()
String	getStyle()
String	getStyleClass()
String	getVerticalViewPortHeight()
String	getWidgetVar()
boolean	isCircular()
boolean	isPaginator()
Boolean	isTouchable()	Is this component touch enabled?
void	setAutoplayInterval(int autoplayInterval)
void	setCircular(boolean circular)
void	setContainerStyleClass(String containerStyleClass)
void	setContentStyleClass(String contentStyleClass)
void	setFooterText(String footerText)
void	setHeaderText(String headerText)
void	setIndicatorsContentStyleClass(String indicatorsContentStyleClass)
void	setNumScroll(int numScroll)
void	setNumVisible(int numVisible)
void	setOnPageChange(String onPageChange)
void	setOrientation(String orientation)
void	setPage(int page)
void	setPaginator(boolean paginator)
void	setResponsiveOptions(List<ResponsiveOption> responsiveOptions)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTouchable(Boolean touchable)	Enable/disable touch support for this component.
void	setVerticalViewPortHeight(String verticalViewPortHeight)
void	setWidgetVar(String widgetVar)

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

broadcast, encodeBegin, encodeChildren, forEachTab, forEachTab, getContainerClientId, getDataModel, getDynamicTab, getIndex, getIndexData, getOffset, getRendersChildren, getRowCount, getSize, getStep, getValue, getVar, getVarStatus, invokeOnComponent, isDynamic, isPrependId, isRepeating, process, processDecodes, processUpdates, processValidators, queueEvent, resetLoadedTabsState, saveState, setDynamic, setIndex, setOffset, setPrependId, setSize, setStep, setValue, setValueExpression, setVar, setVarStatus, shouldSkipChildren, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, 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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

Methods inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder

getBehaviorEventMapping

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

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

Constructor Details

CarouselBase

public CarouselBase()

Method Details

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

getPage

public int getPage()

setPage

public void setPage(int page)

isCircular

public boolean isCircular()

setCircular

public void setCircular(boolean circular)

getAutoplayInterval

public int getAutoplayInterval()

setAutoplayInterval

public void setAutoplayInterval(int autoplayInterval)

getNumVisible

public int getNumVisible()

setNumVisible

public void setNumVisible(int numVisible)

getNumScroll

public int getNumScroll()

setNumScroll

public void setNumScroll(int numScroll)

getResponsiveOptions

public List<ResponsiveOption> getResponsiveOptions()

setResponsiveOptions

public void setResponsiveOptions(List<ResponsiveOption> responsiveOptions)

getOrientation

public String getOrientation()

setOrientation

public void setOrientation(String orientation)

getVerticalViewPortHeight

public String getVerticalViewPortHeight()

setVerticalViewPortHeight

public void setVerticalViewPortHeight(String verticalViewPortHeight)

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

getContentStyleClass

public String getContentStyleClass()

setContentStyleClass

public void setContentStyleClass(String contentStyleClass)

getContainerStyleClass

public String getContainerStyleClass()

setContainerStyleClass

public void setContainerStyleClass(String containerStyleClass)

getIndicatorsContentStyleClass

public String getIndicatorsContentStyleClass()

setIndicatorsContentStyleClass

public void setIndicatorsContentStyleClass(String indicatorsContentStyleClass)

getHeaderText

public String getHeaderText()

setHeaderText

public void setHeaderText(String headerText)

getFooterText

public String getFooterText()

setFooterText

public void setFooterText(String footerText)

isTouchable

public Boolean isTouchable()

Description copied from interface: TouchAware

Is this component touch enabled?

Specified by:

isTouchable in interface TouchAware

Returns:

false to disable

setTouchable

public void setTouchable(Boolean touchable)

Description copied from interface: TouchAware

Enable/disable touch support for this component.

Specified by:

setTouchable in interface TouchAware

Parameters:

touchable - true for touch support

getOnPageChange

public String getOnPageChange()

setOnPageChange

public void setOnPageChange(String onPageChange)

isPaginator

public boolean isPaginator()

setPaginator

public void setPaginator(boolean paginator)