oracle.adf.view.rich.component.rich.data

Class RichCarousel

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXCollection

org.apache.myfaces.trinidad.component.UIXIterator

oracle.adf.view.rich.component.rich.data.PartialRichCarousel

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

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, 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 PartialRichCarousel
implements org.apache.myfaces.trinidad.model.RowKeyIndex, org.apache.myfaces.trinidad.component.CollectionComponent

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXCollection

org.apache.myfaces.trinidad.component.UIXCollection.NoColumnFacetsVisitContext

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

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

Fields inherited from class oracle.adf.view.rich.component.rich.data.PartialRichCarousel

AUXILIARY_OFFSET_KEY, AUXILIARY_POP_OUT_HOVER, AUXILIARY_POP_OUT_KEY, AUXILIARY_POP_OUT_OFF, AUXILIARY_SCALE_KEY, CAROUSEL_SPIN_LISTENER_KEY, CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, COMPONENT_TYPE, CONTENT_DELIVERY_IMMEDIATE, CONTENT_DELIVERY_KEY, CONTENT_DELIVERY_LAZY, CONTROL_AREA_COMPACT, CONTROL_AREA_FULL, CONTROL_AREA_KEY, CONTROL_AREA_NONE, CONTROL_AREA_SMALL, CURRENT_ITEM_KEY_KEY, CUSTOMIZATION_ID_KEY, DISABLED_KEY, DISPLAY_ITEMS_CIRCULAR, DISPLAY_ITEMS_KEY, DISPLAY_ITEMS_ONE_BY_ONE, EMPTY_TEXT_KEY, FETCH_SIZE_KEY, HALIGN_CENTER, HALIGN_END, HALIGN_KEY, HALIGN_START, IMMEDIATE_KEY, INLINE_STYLE_KEY, NODE_STAMP_FACET, ORIENTATION_HORIZONTAL, ORIENTATION_KEY, ORIENTATION_VERTICAL, PARTIAL_TRIGGERS_KEY, SHORT_DESC_KEY, STYLE_CLASS_KEY, TYPE, UNSECURE_KEY, VALIGN_BOTTOM, VALIGN_KEY, VALIGN_MIDDLE, VALIGN_TOP, 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

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

Constructors

Constructor and Description
RichCarousel() Construct an instance of the RichCarousel.
RichCarousel(String rendererType) Construct an instance of the RichCarousel.

Method Summary

Methods

Modifier and Type	Method and Description
void	__decodeChildrenImpl(javax.faces.context.FacesContext context)
void	__updateChildrenImpl(javax.faces.context.FacesContext context)
void	__validateChildrenImpl(javax.faces.context.FacesContext context)
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.
Object	getRowDataForCurrentItemSubKey(int index) If the carousel model is bound to a treeModel, the keys are lists.
protected List<javax.faces.component.UIComponent>	getStamps() Gets the UIComponents that are considered stamps.
void	queueEvent(javax.faces.event.FacesEvent e)
protected boolean	visitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class oracle.adf.view.rich.component.rich.data.PartialRichCarousel

addCarouselSpinListener, addClientBehavior, getAuxiliaryOffset, getAuxiliaryPopOut, getAuxiliaryScale, getBeanType, getCarouselSpinListener, getCarouselSpinListeners, getClientAttributes, getClientBehaviors, getClientListeners, getContentDelivery, getControlArea, getCurrentItemKey, getCustomizationId, getDefaultEventName, getDisplayItems, getEmptyText, getEventNames, getFamily, getFetchSize, getHalign, getInlineStyle, getNodeStamp, getOrientation, getPartialTriggers, getShortDesc, getStyleClass, getUnsecure, getValign, isClientComponent, isDisabled, isImmediate, isVisible, removeCarouselSpinListener, setAuxiliaryOffset, setAuxiliaryPopOut, setAuxiliaryScale, setCarouselSpinListener, setClientAttributes, setClientComponent, setClientListeners, setContentDelivery, setControlArea, setCurrentItemKey, setCustomizationId, setDisabled, setDisplayItems, setEmptyText, setFetchSize, setHalign, setImmediate, setInlineStyle, setNodeStamp, setOrientation, setPartialTriggers, setShortDesc, setStyleClass, setUnsecure, setValign, setVisible

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, visitData

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection

areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processFlattenedChildrenBegin, processRestoreState, processSaveState, processUpdates, processValidators, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildrenWithoutIterating, visitUnstampedFacets

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, 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

Constructor Detail

RichCarousel

public RichCarousel()

Construct an instance of the RichCarousel.

RichCarousel

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

getStamps

protected List<javax.faces.component.UIComponent> getStamps()

Gets the UIComponents that are considered stamps. This implementation simply returns the children of this component.

Overrides:

getStamps in class org.apache.myfaces.trinidad.component.UIXCollection

Returns:

each element must be of type UIComponent.

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

visitChildren

protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext,
                    javax.faces.component.visit.VisitCallback callback)

Overrides:

visitChildren in class org.apache.myfaces.trinidad.component.UIXCollection