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.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, TouchAware, Widget

Direct Known Subclasses:

Carousel

public abstract class CarouselBase
extends UITabPanel
implements Widget, TouchAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CarouselBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY
static 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.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()
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()
String	getStyle()
String	getStyleClass()
int	getToggleSpeed()
String	getWidgetVar()
boolean	isCircular()
boolean	isCollapsed()
boolean	isResponsive()
boolean	isStateful()
boolean	isToggleable()
boolean	isTouchable()	Is this component touch enabled?
boolean	isVertical()
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	setStateful(boolean stateful)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setToggleable(boolean toggleable)
void	setToggleSpeed(int toggleSpeed)
void	setTouchable(boolean touchable)	Enable/disable touch support for this component.
void	setVertical(boolean vertical)
void	setWidgetVar(String widgetVar)

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

broadcast, encodeBegin, encodeChildren, getContainerClientId, getDataModel, getFacesContext, 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, 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 org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Detail

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 Detail

CarouselBase

public CarouselBase()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

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()

setPageLinks

public void setPageLinks(int pageLinks)

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)

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