Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.component.rich.data
Class RichCarousel

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCollection
                  extended by org.apache.myfaces.trinidad.component.UIXIterator
                      extended by oracle.adf.view.rich.component.rich.data.RichCarousel

All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.component.FlattenedComponent, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex

public class RichCarousel
extends org.apache.myfaces.trinidad.component.UIXIterator
implements org.apache.myfaces.trinidad.component.CollectionComponent

The carousel component displays a spinning series of items based on rows of a collection model. <section name="Carousel_Model"> The carousel component uses a model to access the data in the underlying list. The specific model class is oracle.adf.view.rich.model.CollectionModel. You may also use other model instances, e.g., java.util.List, array, and javax.faces.model.DataModel. The carousel will automatically convert the instance into a CollectionModel. </section> <section name="Fetch_Size"> The carousel component is virtualized. This means that not all the rows that are available for the component on the server are fetched and displayed on the client. The number of rows that are displayed on the client should generally be just enough to fill the viewport. More rows are fetched as the user spins the carousel. "fetchSize" is the number of rows requested from the client to the server on each attempt to fill the component. So if the space allocated for the carousel is small, the fetch size of 25 may be sufficient to fill the component. However if the space allocated for the carousel is large, there might be a need to request the data multiple times from the server. If the carousel has to make a request to the server 2 times when fetchSize is 25, it may be appropriate to set the fetchSize to 50. </section> <section name="CSS_Style_Restriction"> The carousel requires dimensions to display. Either the carousel must be placed in a parent component that will stretch it or the carousel must have explicit dimensions which are provided by the skin. You need to be careful to not apply an inlineStyle or styleClass that would change the dimensions to be indeterminate. </section> <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children. e.g., panelStretchLayout, panelSplitter.</html:li> <html:li>This component only accepts carouselItem children and they will be stretched as needed to fit within the dimensions allocate by the carousel. Refer to the carouselItem documentation for details on how geometry is managed for carouselItem children.</html:li> </html:ul> </section> <section name="Attribute_Notes"> The "first" and "rows" attributes inherited from the UIXIterator superclass are not currently supported for the rich render kit. </section>

Events:

Type Phases Description
oracle.adf.view.rich.event.CarouselSpinEvent Apply Request Values
Invoke Application
The spin event is delivered when the table selection changes.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Nested Class Summary

 

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex
org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy

 

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey CAROUSEL_SPIN_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String CONTENT_DELIVERY_IMMEDIATE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
           
static java.lang.String CONTENT_DELIVERY_LAZY
           
static java.lang.String CONTROL_AREA_COMPACT
           
static java.lang.String CONTROL_AREA_FULL
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTROL_AREA_KEY
           
static java.lang.String CONTROL_AREA_SMALL
           
static org.apache.myfaces.trinidad.bean.PropertyKey CURRENT_ITEM_KEY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
          Deprecated. 
static org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
           
static java.lang.String DISPLAY_ITEMS_CIRCULAR
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ITEMS_KEY
           
static java.lang.String DISPLAY_ITEMS_ONE_BY_ONE
           
static org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY
           
static java.lang.String HALIGN_CENTER
           
static java.lang.String HALIGN_END
           
static org.apache.myfaces.trinidad.bean.PropertyKey HALIGN_KEY
           
static java.lang.String HALIGN_START
           
static org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static java.lang.String NODE_STAMP_FACET
           
static java.lang.String ORIENTATION_HORIZONTAL
           
static org.apache.myfaces.trinidad.bean.PropertyKey ORIENTATION_KEY
           
static java.lang.String ORIENTATION_VERTICAL
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
           
static java.lang.String VALIGN_BOTTOM
           
static org.apache.myfaces.trinidad.bean.PropertyKey VALIGN_KEY
           
static java.lang.String VALIGN_MIDDLE
           
static java.lang.String VALIGN_TOP
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
           

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXIterator
FIRST_KEY, ROWS_KEY, VALUE_KEY, VAR_STATUS_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXCollection
VAR_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

 

Fields inherited from class javax.faces.component.UIComponent
bindings

 

Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR

 

Constructor Summary
  RichCarousel()
          Construct an instance of the RichCarousel.
protected RichCarousel(java.lang.String rendererType)
          Construct an instance of the RichCarousel.

 

Method Summary
 void __decodeChildrenImpl(javax.faces.context.FacesContext context)
           
 void __updateChildrenImpl(javax.faces.context.FacesContext context)
           
 void __validateChildrenImpl(javax.faces.context.FacesContext context)
           
 void addCarouselSpinListener(CarouselSpinListener listener)
          Adds a carouselSpin listener.
 void broadcast(javax.faces.event.FacesEvent event)
           
 void drillIntoCurrentItemKey()
          If the carousel model is bound to a treeModel, drills the carousel into the current item key, so that it can display items inside the node represented by the current item key.
 void drillIntoCurrentItemSubKey(int index)
          If the carousel model is bound to a treeModel, the keys are lists.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 javax.el.MethodExpression getCarouselSpinListener()
          Gets a method reference to a carousel spin listener
 CarouselSpinListener[] getCarouselSpinListeners()
          Returns an array of attached carouselSpin listeners.
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 java.lang.String getContentDelivery()
          Gets whether data should be fetched when the component is rendered initially.
 java.lang.String getControlArea()
          Gets specifies how the area where the user spins the carousel is presented.
 java.lang.Object getCurrentItemKey()
          Gets the key that identifies the current item in this component.
 java.lang.String getCustomizationId()
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 java.lang.String getDisplayItems()
          Gets the current carousel item will always be shown but you can use this attribute to specify how the auxiliary carousel items are displayed.
 java.lang.String getEmptyText()
          Gets the text of an empty carousel.
 java.lang.String getFamily()
           
 int getFetchSize()
          Gets the number of rows in the data fetch block
 java.lang.String getHalign()
          Gets determines the horizontal alignment of the carousel items.
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 javax.faces.component.UIComponent getNodeStamp()
          the component to use to stamp each element in the carousel.
 java.lang.String getOrientation()
          Gets horizontal (the default) for the images being displayed along an x-axis or vertical for y-axis.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 java.lang.Object getRowDataForCurrentItemSubKey(int index)
          If the carousel model is bound to a treeModel, the keys are lists.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.util.Set<java.lang.String> getUnsecure()
          Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 java.lang.String getValign()
          Gets determines the vertical alignment of the carousel items.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isDisabled()
          Gets a boolean which if the value is "true", the component becomes non-interactive.
 boolean isImmediate()
          Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
 boolean isVisible()
          Gets the visibility of the component.
 void queueEvent(javax.faces.event.FacesEvent e)
           
 void removeCarouselSpinListener(CarouselSpinListener listener)
          Removes a carouselSpin listener.
 void setCarouselSpinListener(javax.el.MethodExpression carouselSpinListener)
          Sets a method reference to a carousel spin listener
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setClientComponent(boolean clientComponent)
          Sets whether a client-side component will be generated.
 void setClientListeners(ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setContentDelivery(java.lang.String contentDelivery)
          Sets whether data should be fetched when the component is rendered initially.
 void setControlArea(java.lang.String controlArea)
          Sets specifies how the area where the user spins the carousel is presented.
 void setCurrentItemKey(java.lang.Object currentItemKey)
          Sets the key that identifies the current item in this component.
 void setCustomizationId(java.lang.String customizationId)
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 void setDisabled(boolean disabled)
          Sets a boolean which if the value is "true", the component becomes non-interactive.
 void setDisplayItems(java.lang.String displayItems)
          Sets the current carousel item will always be shown but you can use this attribute to specify how the auxiliary carousel items are displayed.
 void setEmptyText(java.lang.String emptyText)
          Sets the text of an empty carousel.
 void setFetchSize(int fetchSize)
          Sets the number of rows in the data fetch block
 void setHalign(java.lang.String halign)
          Sets determines the horizontal alignment of the carousel items.
 void setImmediate(boolean immediate)
          Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)
          the component to use to stamp each element in the carousel.
 void setOrientation(java.lang.String orientation)
          Sets horizontal (the default) for the images being displayed along an x-axis or vertical for y-axis.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setUnsecure(java.util.Set<java.lang.String> unsecure)
          Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 void setValign(java.lang.String valign)
          Sets determines the vertical alignment of the carousel items.
 void setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXIterator
createCollectionModel, createVarStatusMap, encodeChildren, getFirst, getRendersChildren, getRows, getValue, getVarStatus, isFlatteningChildren, processFacetsAndChildren, processFlattenedChildren, setFirst, setRows, setValue, setVarStatus, visitTree

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface org.apache.myfaces.trinidad.component.CollectionComponent
getFirst, getRows, getVar

 

Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex
getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey

 

Methods inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable

 

Field Detail

ORIENTATION_HORIZONTAL

public static final java.lang.String ORIENTATION_HORIZONTAL
See Also:
Constant Field Values

ORIENTATION_VERTICAL

public static final java.lang.String ORIENTATION_VERTICAL
See Also:
Constant Field Values

HALIGN_START

public static final java.lang.String HALIGN_START
See Also:
Constant Field Values

HALIGN_CENTER

public static final java.lang.String HALIGN_CENTER
See Also:
Constant Field Values

HALIGN_END

public static final java.lang.String HALIGN_END
See Also:
Constant Field Values

VALIGN_MIDDLE

public static final java.lang.String VALIGN_MIDDLE
See Also:
Constant Field Values

VALIGN_TOP

public static final java.lang.String VALIGN_TOP
See Also:
Constant Field Values

VALIGN_BOTTOM

public static final java.lang.String VALIGN_BOTTOM
See Also:
Constant Field Values

DISPLAY_ITEMS_CIRCULAR

public static final java.lang.String DISPLAY_ITEMS_CIRCULAR
See Also:
Constant Field Values

DISPLAY_ITEMS_ONE_BY_ONE

public static final java.lang.String DISPLAY_ITEMS_ONE_BY_ONE
See Also:
Constant Field Values

CONTROL_AREA_FULL

public static final java.lang.String CONTROL_AREA_FULL
See Also:
Constant Field Values

CONTROL_AREA_SMALL

public static final java.lang.String CONTROL_AREA_SMALL
See Also:
Constant Field Values

CONTROL_AREA_COMPACT

public static final java.lang.String CONTROL_AREA_COMPACT
See Also:
Constant Field Values

CONTENT_DELIVERY_IMMEDIATE

public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
See Also:
Constant Field Values

CONTENT_DELIVERY_LAZY

public static final java.lang.String CONTENT_DELIVERY_LAZY
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

ORIENTATION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ORIENTATION_KEY

HALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HALIGN_KEY

VALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALIGN_KEY

DISPLAY_ITEMS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ITEMS_KEY

CONTROL_AREA_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTROL_AREA_KEY

IMMEDIATE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IMMEDIATE_KEY

CURRENT_ITEM_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CURRENT_ITEM_KEY_KEY

FETCH_SIZE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY

EMPTY_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY

DISABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY

CAROUSEL_SPIN_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CAROUSEL_SPIN_LISTENER_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
Deprecated. 

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

NODE_STAMP_FACET

public static final java.lang.String NODE_STAMP_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

RichCarousel

public RichCarousel()
Construct an instance of the RichCarousel.

RichCarousel

protected RichCarousel(java.lang.String rendererType)
Construct an instance of the RichCarousel.

Method Detail

__decodeChildrenImpl

public void __decodeChildrenImpl(javax.faces.context.FacesContext context)

__validateChildrenImpl

public void __validateChildrenImpl(javax.faces.context.FacesContext context)

__updateChildrenImpl

public void __updateChildrenImpl(javax.faces.context.FacesContext context)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class org.apache.myfaces.trinidad.component.UIXCollection
Throws:
javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)
Overrides:
queueEvent in class org.apache.myfaces.trinidad.component.UIXCollection

drillIntoCurrentItemKey

public void drillIntoCurrentItemKey()
If the carousel model is bound to a treeModel, drills the carousel into the current item key, so that it can display items inside the node represented by the current item key. The drill down will only happen if the current item is a parent container. After the drill down the new key will be the first item under the current item key

getRowDataForCurrentItemSubKey

public java.lang.Object getRowDataForCurrentItemSubKey(int index)
If the carousel model is bound to a treeModel, the keys are lists. This method returns the data for a particular node represented by the subkey in the list for the currentItemKey.
Parameters:
index - used to get subkey from currentItemKey. The subkey is the key from 0 to index in the key list for the tree model.
Returns:
Object representing the data for the node represented by the subm=key

drillIntoCurrentItemSubKey

public void drillIntoCurrentItemSubKey(int index)
If the carousel model is bound to a treeModel, the keys are lists. This method moves the currentItemKey to a particular subkey in the list. The carousel component is also PPRed so that it can display the new data represented by this new subkey.
Parameters:
index - used to get subkey from currentItemKey. The subkey is the key from 0 to index in the key list for the tree model.

getNodeStamp

public final javax.faces.component.UIComponent getNodeStamp()
the component to use to stamp each element in the carousel. A carouselItem child is required.

setNodeStamp

public final void setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)
the component to use to stamp each element in the carousel. A carouselItem child is required.

getOrientation

public final java.lang.String getOrientation()
Gets horizontal (the default) for the images being displayed along an x-axis or vertical for y-axis.
Returns:
the new orientation value

setOrientation

public final void setOrientation(java.lang.String orientation)
Sets horizontal (the default) for the images being displayed along an x-axis or vertical for y-axis.
Parameters:
orientation - the new orientation value

getHalign

public final java.lang.String getHalign()
Gets determines the horizontal alignment of the carousel items.
Returns:
the new halign value

setHalign

public final void setHalign(java.lang.String halign)
Sets determines the horizontal alignment of the carousel items.
Parameters:
halign - the new halign value

getValign

public final java.lang.String getValign()
Gets determines the vertical alignment of the carousel items.
Returns:
the new valign value

setValign

public final void setValign(java.lang.String valign)
Sets determines the vertical alignment of the carousel items.
Parameters:
valign - the new valign value

getDisplayItems

public final java.lang.String getDisplayItems()
Gets the current carousel item will always be shown but you can use this attribute to specify how the auxiliary carousel items are displayed. Use "circular" if you want the auxiliary items displayed near the current item in a scaled down pattern with as many items shown as will fit. Use "oneByOne" if you only want the current item shown.
Returns:
the new displayItems value

setDisplayItems

public final void setDisplayItems(java.lang.String displayItems)
Sets the current carousel item will always be shown but you can use this attribute to specify how the auxiliary carousel items are displayed. Use "circular" if you want the auxiliary items displayed near the current item in a scaled down pattern with as many items shown as will fit. Use "oneByOne" if you only want the current item shown.
Parameters:
displayItems - the new displayItems value

getControlArea

public final java.lang.String getControlArea()
Gets specifies how the area where the user spins the carousel is presented. The "full" option lets a user spin through carousel items one at a time, jump to a specific item, or drag the slider thumb to continuously spin the carousel until the mouse is let go. The "small" option lets a user click the next and previous buttons to spin through carousel items one at a time. The "compact" option is similar to "small" but omits details such as the "x of y" progress information.
Returns:
the new controlArea value

setControlArea

public final void setControlArea(java.lang.String controlArea)
Sets specifies how the area where the user spins the carousel is presented. The "full" option lets a user spin through carousel items one at a time, jump to a specific item, or drag the slider thumb to continuously spin the carousel until the mouse is let go. The "small" option lets a user click the next and previous buttons to spin through carousel items one at a time. The "compact" option is similar to "small" but omits details such as the "x of y" progress information.
Parameters:
controlArea - the new controlArea value

isImmediate

public final boolean isImmediate()
Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.
Returns:
the new immediate value

setImmediate

public final void setImmediate(boolean immediate)
Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.
Parameters:
immediate - the new immediate value

getCurrentItemKey

public final java.lang.Object getCurrentItemKey()
Gets the key that identifies the current item in this component.
Returns:
the new currentItemKey value

setCurrentItemKey

public final void setCurrentItemKey(java.lang.Object currentItemKey)
Sets the key that identifies the current item in this component.
Parameters:
currentItemKey - the new currentItemKey value

getFetchSize

public final int getFetchSize()
Gets the number of rows in the data fetch block
Returns:
the new fetchSize value

setFetchSize

public final void setFetchSize(int fetchSize)
Sets the number of rows in the data fetch block
Parameters:
fetchSize - the new fetchSize value

getEmptyText

public final java.lang.String getEmptyText()
Gets the text of an empty carousel. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.
Returns:
the new emptyText value

setEmptyText

public final void setEmptyText(java.lang.String emptyText)
Sets the text of an empty carousel. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.
Parameters:
emptyText - the new emptyText value

getContentDelivery

public final java.lang.String getContentDelivery()
Gets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request.
Returns:
the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)
Sets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request.
Parameters:
contentDelivery - the new contentDelivery value

isDisabled

public final boolean isDisabled()
Gets a boolean which if the value is "true", the component becomes non-interactive. Otherwise, the default value is "false" and component assumes its expected behavior.
Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets a boolean which if the value is "true", the component becomes non-interactive. Otherwise, the default value is "false" and component assumes its expected behavior.
Parameters:
disabled - the new disabled value

getCarouselSpinListener

public final javax.el.MethodExpression getCarouselSpinListener()
Gets a method reference to a carousel spin listener
Returns:
the new carouselSpinListener value

setCarouselSpinListener

public final void setCarouselSpinListener(javax.el.MethodExpression carouselSpinListener)
Sets a method reference to a carousel spin listener
Parameters:
carouselSpinListener - the new carouselSpinListener value

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
Returns:
the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
Parameters:
unsecure - the new unsecure value

isVisible

public final boolean isVisible()
Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Parameters:
visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Parameters:
clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

addCarouselSpinListener

public final void addCarouselSpinListener(CarouselSpinListener listener)
Adds a carouselSpin listener.
Parameters:
listener - the carouselSpin listener to add

removeCarouselSpinListener

public final void removeCarouselSpinListener(CarouselSpinListener listener)
Removes a carouselSpin listener.
Parameters:
listener - the carouselSpin listener to remove

getCarouselSpinListeners

public final CarouselSpinListener[] getCarouselSpinListeners()
Returns an array of attached carouselSpin listeners.
Returns:
an array of attached carouselSpin listeners.

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXIterator

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXIterator

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.