JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlCarouselPeer

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlCarouselPeer

public class AdfDhtmlCarouselPeer
extends AdfRichUIPeer

_animDuration

private Object _animDuration

DW_SUB_ID

public static Object DW_SUB_ID

_FETCH_DELAY_TIMEOUT

private static Object _FETCH_DELAY_TIMEOUT

_FETCH_MORE_ITEM_COUNT

private static Object _FETCH_MORE_ITEM_COUNT

_fetchId

private Object _fetchId

_INPUT_REGEXP

private static Object _INPUT_REGEXP

_isVertical

private Object _isVertical

_ITEM_PADDING

private static Object _ITEM_PADDING

_MAX_PLACEHOLDERS_ON_ONE_SIDE

private static Object _MAX_PLACEHOLDERS_ON_ONE_SIDE

MISSING_AFTER

public static Object MISSING_AFTER

MISSING_BEFORE

public static Object MISSING_BEFORE

_NEEDS_REFRESH_ATTRIBUTE

private static Object _NEEDS_REFRESH_ATTRIBUTE

NO_BLOCKS

public static Object NO_BLOCKS

_POP_OUT

private Object _POP_OUT

_popOutDuration

private Object _popOutDuration

_ROW_KEY

private static Object _ROW_KEY

_setupInitialPositions

private Object _setupInitialPositions

_SHIFT_FACTOR

private Object _SHIFT_FACTOR

_SHRINK_FACTOR

private Object _SHRINK_FACTOR

_SUB_ID_MAP

private static Object _SUB_ID_MAP

carousel component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [spinPrevious --> sp] - carousel spin previous button 2. [spinNext --> sn] - carousel spin next button 3. [itemText --> it] - carousel current item text {External indexing example --> Internal indexing example} getElementText("rich=dmoTpl:carousel[2]:ot4"); -->

_unavailableRowIndex

private Object _unavailableRowIndex

_UNDO_FETCH_ATTRIBUTE

private static Object _UNDO_FETCH_ATTRIBUTE

_useOpacity

private Object _useOpacity

VIEWPORT_SATISFIED

public static Object VIEWPORT_SATISFIED

AdfDhtmlCarouselPeer

public AdfDhtmlCarouselPeer()

_addAfter

private Object _addAfter(Object dataBody,
                         Object delay,
                         Object isScroll)

Parameters:

dataBody
delay
isScroll

Return:

Object

_addBefore

private Object _addBefore(Object dataBody,
                          Object delay,
                          Object isScroll)

Parameters:

dataBody
delay
isScroll

Return:

Object

_addDataBlockItems

private Object _addDataBlockItems(Object dataBody,
                                  Object newBlock,
                                  Object prepend)

Parameters:

dataBody
newBlock
prepend

Return:

Object

_addEmptyTextToDataBody

private Object _addEmptyTextToDataBody(HTMLElement dataBody,
                                       HTMLElement newElement)

Adds the empty text to the data body.

Parameters:

dataBody	-	the dataBody of the carousel where the empty text will be shown
newElement	-	the container that holds the empty text fetched from the server

Return:

Object

_addInvalidDataBlock

private Object _addInvalidDataBlock(HTMLElement oldElement,
                                    HTMLElement newBlock,
                                    HTMLElement existingDataBody)

If we get a block of data that is not valid because the user has been jumping around randomly. Add all of the elements to the data fetch hidden div, but make sure that the element does not exist in our viewport already otherwise just discard that item.

Parameters:

oldElement	-	the hidden div that is used to transfer elements
newBlock	-	the newly fetched data block
existingDataBody	-	the dataBody element

Return:

Object

_adjustRowCountFromResponse

private Object _adjustRowCountFromResponse(Object dataBody,
                                           Object node)

Parameters:

dataBody
node

Return:

Object

_allRowsAvailableOnClient

private Object _allRowsAvailableOnClient(Object block)

Determine if all rows are available locally on the client

Parameters:

block

Return:

Object

_animateForLongJump

private Object _animateForLongJump(Object fullNeededPlaceholderCount,
                                   Object spinTowardsNext,
                                   Object itemsFromCurrentlyAvailableEdge)

Parameters:

fullNeededPlaceholderCount
spinTowardsNext
itemsFromCurrentlyAvailableEdge

Return:

Object

_animateRowsForNewSelectedWrapperElement

private Object _animateRowsForNewSelectedWrapperElement(Object selectedWrapper,
                                                        Object oldCurrentItemKey,
                                                        Object addPlaceholders,
                                                        Object popOutDetails)

Parameters:

selectedWrapper
oldCurrentItemKey
addPlaceholders
popOutDetails

Return:

Object

_callCallback

private Object _callCallback(Object callback)

Method to call a callback

Parameters:

callback

-

- the callback function to call, can be null

Return:

Object

_cancelPendingFetch

private Object _cancelPendingFetch()

Return:

Object

CarouselItemInitialized

protected Object CarouselItemInitialized(String clientId)

Method invoked by AdfDhtmlCarouselItemPeer instances when a carouselItem component is initialized since this is the only way for the carousel to be notified when a new carouselItem component has been fetched and initialized. Some operations that require the component to be initialized include: - updating the carousel with the new current item's text - performing the initial resize notifications on the carouselItem

Parameters:

clientId

-

the client ID of the carouselItem that was just initialized

Return:

Object

ChildVisibilityChanged

protected Object ChildVisibilityChanged(Object childComponent,
                                        Object childDomElement,
                                        Object childVisible)

Override to PPR the component when a column is hidden

Parameters:

childComponent
childDomElement
childVisible

Return:

Object

Overrides:

AdfRichUIPeer.ChildVisibilityChanged(Object, Object, Object)

_cleanUpHoverState

private Object _cleanUpHoverState()

Return:

Object

_collectClientTokens

private Object _collectClientTokens(Object cacheType)

Parameters:

cacheType

Return:

Object

ComponentCurrentItemKeyChanged

protected Object ComponentCurrentItemKeyChanged(Object component,
                                                Object domElement,
                                                Object newValue,
                                                Object oldValue)

Selection Logic (Row and Column)

Parameters:

component
domElement
newValue
oldValue

Return:

Object

ComponentRemoved

protected Object ComponentRemoved(AdfUIComponent component)

Handles the removal of a component.

Parameters:

component

-

The component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

ConvertClientIdToLocator

protected Object ConvertClientIdToLocator(AdfUIComponent component,
                                          Object childComponent,
                                          String descComponentClientId,
                                          Array<Object> replaceArray)

Function to replace client id fragments when converting a clientId to an absolute locator. It tries to find the rowKey information for the childComponent. If rowKey exists, skip the first id fragment after the carousel id and append the rowIndex in the format carouselId[rowIndex] else skip the first id fragment after the carousel id.

The peer is not bound when this method is called

Parameters:

component	-	The region component for this peer
childComponent
descComponentClientId	-	The clientId of the component that the absolute scoped id is being generated for
replaceArray	-	Array of key-value array in format [index, item] to either skip or skip and fix the parent id fragment with the item value

Return:

Object

Overrides:

AdfRichUIPeer.ConvertClientIdToLocator(Object, Object, Object, Object)

convertLocatorToClientId

public String convertLocatorToClientId(AdfUIComponent component,
                                       Number rowIndex)

Function to replace client id fragments when converting an absolute locator to clientId.

Parameters:

component	-	The carousel component for this peer
rowIndex	-	The index of the row for the component

Return:

String - The client id fragment in the below format clientId + ":" + stamped rowKey client Id fragment related to rowIndex

Overrides:

AdfUIPeer.convertLocatorToClientId(Object, Object)

_createPlaceholder

private Object _createPlaceholder(Object sibling,
                                  Object isNext,
                                  Object alpha)

Parameters:

sibling
isNext
alpha

Return:

Object

_currentItemTextUpdate

private Object _currentItemTextUpdate(Object itemClientId)

Parameters:

itemClientId

Return:

Object

_deleteOffscreenItems

private Object _deleteOffscreenItems(Object dataBody,
                                     Object deletePrevious)

Parameters:

dataBody
deletePrevious

Return:

Object

_displayStatus

private Object _displayStatus(Object text)

Parameters:

text

Return:

Object

_domReplacedListener

private Object _domReplacedListener(Event event)

Dom replaced listener that calls registered callback

Parameters:

event

-

the event received

Return:

Object

DomReplaceNotify

protected Object DomReplaceNotify(Object domNode)

Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.

Parameters:

domNode

Return:

Object

Overrides:

AdfRichUIPeer.domReplaceNotify(AdfUIComponent, Object)

_doResizeNotifyOnDisplayedChildren

private Object _doResizeNotifyOnDisplayedChildren(Object component)

Parameters:

component

Return:

Object

_fillViewPort

private Object _fillViewPort(Object dataBody,
                             Object delay,
                             Object isScroll)

Scrolling and virtualization

Parameters:

dataBody
delay
isScroll

Return:

Object

_findFirstChildByTagName

private static Object _findFirstChildByTagName(Object parent,
                                               Object name)

Parameters:

parent
name

Return:

Object

_findRowByKey

private Object _findRowByKey(String rowKey,
                             Boolean firstByDefault)

Returns the row and the index associated with the rowKey in the dom structure

Parameters:

rowKey	-	the rowKey to look for in dom structure
firstByDefault	-	true if the first available row should be returned when the given rowKey is not non-null but no corresponding row info is present (e.g. rowKey was from an old state of the data model but the member currentItemKey was not reset)

Return:

Object - an object literal with row and index attributes if the rowkey is found else null

_finishDataBodyDrag

private Object _finishDataBodyDrag(Object domEvent,
                                   Object deltaX,
                                   Object deltaY)

Parameters:

domEvent
deltaX
deltaY

Return:

Object

_finishThumbDrag

private Object _finishThumbDrag(Object domEvent,
                                Object deltaX,
                                Object deltaY)

Parameters:

domEvent
deltaX
deltaY

Return:

Object

_getAuxShiftSizeAndOpacity

private Object _getAuxShiftSizeAndOpacity(Object offsetIndex)

Given the offset index of the auxillary item, caculates its shift, size and the opacity.

Parameters:

offsetIndex

Return:

Object

GetBestMatchSubId

protected Object GetBestMatchSubId(Object domElement)

Returns the best match subId for the given domElement. This can be enhanced further to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

domElement

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

Overrides:

AdfRichUIPeer.GetBestMatchSubId(Object)

_getChildBySubId

private static Object _getChildBySubId(Object parent,
                                       Object sub)

Parameters:

parent
sub

Return:

Object

_getControlAreaDiv

private Object _getControlAreaDiv(Object rootDomElement)

Parameters:

rootDomElement

Return:

Object

_getCurrentPercent

private Object _getCurrentPercent()

Return:

Object

_getDataBody

private Object _getDataBody(Object rootDomElement)

Parameters:

rootDomElement

Return:

Object

_getElemBySubId

private Object _getElemBySubId(Object sub,
                               Object rootDomElement)

Gets an element belonging to this peer based on the root DOM element.

Parameters:

sub	-	the sub ID to identify the sub element
rootDomElement

Return:

Object - the found sub element or null if not found

_getFirstNonPlaceholder

private Object _getFirstNonPlaceholder(Object blockOfRows)

Parameters:

blockOfRows

Return:

Object

_getHalignLeft

private Object _getHalignLeft(Object vertical,
                              Object halign,
                              Object dbWidth,
                              Object itemSize,
                              Object shift)

Parameters:

vertical
halign
dbWidth
itemSize
shift

Return:

Object

_getItemTextDiv

private Object _getItemTextDiv(Object clientId)

Parameters:

clientId

Return:

Object

_getLastNonPlaceholder

private Object _getLastNonPlaceholder(Object blockOfRows)

Parameters:

blockOfRows

Return:

Object

_getNextRowKeyAndRow

private Object _getNextRowKeyAndRow(Object selectedRowKey)

Returns the rowkey and the row after the selected row.

Parameters:

selectedRowKey

Return:

Object

_getNumberOfLeadingPlaceholders

private Object _getNumberOfLeadingPlaceholders(Object blockOfRows)

Parameters:

blockOfRows

Return:

Object

_getNumberOfRows

private Object _getNumberOfRows(Object blockOfRows)

Parameters:

blockOfRows

Return:

Object

_getPreviousRowKeyAndRow

private Object _getPreviousRowKeyAndRow(Object selectedRowKey)

Returns the rowkey and the row before the selected row.

Parameters:

selectedRowKey

Return:

Object

getRowIndex

public Number getRowIndex(String rowKey)

Returns the index of a row identified by rowKey.
There is no guarantee that a row identified by a rowKey can be found on the client since all the rows are not rendered on the client. Also keep in mind that the rowKey on the client is not the same as the one on the server, since the server provides a mechanism for converting client row keys into server row keys.

Parameters:

rowKey

-

the client side rowKey that identifies a row

Return:

Number - the index of a row for a row key if is found otherwise -1.

See also:

getRowKey(Number)

_getRowIndexFromThumbPos

private Object _getRowIndexFromThumbPos()

Return:

Object

getRowKey

public String getRowKey(Number index)

Returns the rowKey to identify a row based on its index.
There is no guarantee that a row identified by a rowKey can be found on the client since all the rows are not rendered on the client. Also keep in mind that the rowKey on the client is not the same as the one on the server, since the server provides a mechanism for converting client row keys into server row keys.

Parameters:

index

-

the rowIndex of the row

Return:

String - the rowKey to identify a row if is found otherwise null.

See also:

getRowIndex(String)

_getRowKeyAndRow

private Object _getRowKeyAndRow(Object domElement,
                                Object rootDomElement)

Returns the row key attribute and the row from a dom element. If necessary, walks up the dom hierarchy to find the element with the rowKey attribute

Parameters:

domElement
rootDomElement

Return:

Object

_getRowKeyForIndex

private Object _getRowKeyForIndex(Object component,
                                  Object rowIndex)

Parameters:

component
rowIndex

Return:

Object

_getSpinControlDiv

private Object _getSpinControlDiv(Object clientId)

Parameters:

clientId

Return:

Object

_getSpinInfoDiv

private Object _getSpinInfoDiv(Object clientId)

Parameters:

clientId

Return:

Object

_getStatusMessage

private Object _getStatusMessage()

Return:

Object

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementIdLocator)

This function returns the dom element of the child element for the provided component; associated with the sub id.

Parameters:

subElementIdLocator

Return:

Object

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

_getUnavailableRowIndex

private Object _getUnavailableRowIndex(Object elem)

As a result of a data fetch, the server can send a special div which includes information about the row index for which the model returned false from the isRowAvailable API. Here we check for this div.

Parameters:

elem

Return:

Object

_getValignTop

private Object _getValignTop(Object vertical,
                             Object valign,
                             Object dbHeight,
                             Object itemSize,
                             Object shift)

Parameters:

vertical
valign
dbHeight
itemSize
shift

Return:

Object

_grabFocus

private Object _grabFocus()

Focus handling

Return:

Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

keyboard handling

Parameters:

componentEvent

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseOut

protected Object HandleComponentMouseOut(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseUp

protected Object HandleComponentMouseUp(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_handleDataBodyDragPositioning

private Object _handleDataBodyDragPositioning(Object domEvent,
                                              Object deltaX,
                                              Object deltaY)

Parameters:

domEvent
deltaX
deltaY

Return:

Object

_handleDataBodySelectStart

private Object _handleDataBodySelectStart(Object evt)

Parameters:

evt

Return:

Object

_handleDataCallback

private Object _handleDataCallback(Object node,
                                   Object pendingFetch,
                                   Object fetchIndex,
                                   Object pendingRenderOnly)

Parameters:

node
pendingFetch
fetchIndex
pendingRenderOnly

Return:

Object

HandleDomMouseMove

protected Object HandleDomMouseMove(Object component,
                                    Object domEvent)

Event Handlers

Parameters:

component
domEvent

Return:

Object

_handleItemClick

private Object _handleItemClick(Object evt,
                                Object rowKey,
                                Object row)

Parameters:

evt
rowKey
row

Return:

Object

_handleLongJump

private Object _handleLongJump(Object dataBody,
                               Object index,
                               Object delay,
                               Object isScroll)

Parameters:

dataBody
index
delay
isScroll

Return:

Object

_handleLongTouchEvent

private Object _handleLongTouchEvent(Object event)

If the event has a target handle this longTouch like a hover

Parameters:

event

-

If not null, hover state will be updated.

Return:

Object

_handleMouseWheel

private static Object _handleMouseWheel(Object evt)

Parameters:

evt

Return:

Object

_handleNextClick

private static Object _handleNextClick(Object domEvent)

Parameters:

domEvent

Return:

Object

_handlePreviousClick

private static Object _handlePreviousClick(Object domEvent)

Parameters:

domEvent

Return:

Object

_handleTabKeyDown

private Object _handleTabKeyDown(Object eventTarget,
                                 Object shiftKey)

Parameters:

eventTarget
shiftKey

Return:

Object

_handleThumbDragPositioning

private Object _handleThumbDragPositioning(Object domEvent,
                                           Object deltaX,
                                           Object deltaY)

Parameters:

domEvent
deltaX
deltaY

Return:

Object

_handleTouchMovement

private Object _handleTouchMovement(Number deltaX,
                                    Number deltaY)

Handler invoked by an AdfTouchMoveManager when the user performs a dual touch movement on the data body.

Parameters:

deltaX	-	the distance moved in the x direction.
deltaY	-	the distance moved in the y direction.

Return:

Object

_hideStatus

private Object _hideStatus()

Return:

Object

_incrementCarouselPosition

private Object _incrementCarouselPosition()

Controller for the main increment or decrement function. This method is called by the AdfObject.createCallback method.

Return:

Object

See also:

AdfObject.createCallback(Object)

InitDomElement

protected Object InitDomElement(Object component,
                                Object domElement)

Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called.

Parameters:

component	-	Component that this peer will be associated with
domElement	-	Root DOM element of this peer

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

_initiateSpinEndAnimation

private Object _initiateSpinEndAnimation()

Return:

Object

_initiateSpinNextAnimation

private Object _initiateSpinNextAnimation()

Return:

Object

_initiateSpinPercentAnimation

private Object _initiateSpinPercentAnimation(Number desiredPercent,
                                             Number currentPercent)

Parameters:

desiredPercent	-	A value from 0 through 1 that indicates where to spin within the range of items.
currentPercent	-	An optional value from 0 through 1 to indicate where the current spin position exists. If undefined, honor the desiredPercent explicitly otherwise make a desiredPercent yield the previous or next item if it resolves to currentPercent (so that clicking on the slider bar will always yield movement).

Return:

Object

_initiateSpinPreviousAnimation

private Object _initiateSpinPreviousAnimation()

Return:

Object

_initiateSpinSpecificExistingItemAnimation

private Object _initiateSpinSpecificExistingItemAnimation(Object desiredRowKey,
                                                          Object desiredRow)

Parameters:

desiredRowKey
desiredRow

Return:

Object

_initiateSpinStartAnimation

private Object _initiateSpinStartAnimation()

Return:

Object

_initMouseHoldIncrementRepeat

private Object _initMouseHoldIncrementRepeat()

Callback function, started by an interval. This function removes itself from the interval and starts a new one, which will only removed, by the mouse up event.

Return:

Object

_initNewBlock

private Object _initNewBlock(Object node,
                             Object start,
                             Object size)

Parameters:

node
start
size

Return:

Object

InitSubclass

protected static Object InitSubclass()

Registers component handlers.

Return:

Object

_initVirtualization

private Object _initVirtualization(Object firstBlock,
                                   Object alreadyInserted)

Parameters:

firstBlock
alreadyInserted

Return:

Object

_isImmediateContentDelivery

private Object _isImmediateContentDelivery(Object component)

Parameters:

component

Return:

Object

_isOwnComponentEvent

private Object _isOwnComponentEvent(Object componentEvent)

Determines whether the component event belongs to this carousel (as opposed to a child carousel displayed in a popup or otherwise)

Parameters:

componentEvent

Return:

Object

_isPlaceholder

private static Object _isPlaceholder(Object element)

Parameters:

element

Return:

Object

_isRTL

private static Object _isRTL()

Return:

Object

_isTargetCellEditable

private Object _isTargetCellEditable(Object node)

Parameters:

node

Return:

Object

_isViewportSatisfied

private Object _isViewportSatisfied(Object dataBody)

Parameters:

dataBody

Return:

Object

needsChildVisibilityChanges

public Object needsChildVisibilityChanges(Object component)

The AdfDhtmlCarouselPeer cares about child visibility changes in order to redraw when columns are hidden/shown

Parameters:

component

Return:

Object

Overrides:

AdfRichUIPeer.needsChildVisibilityChanges(AdfUIComponent)

needsResizeNotify

public Object needsResizeNotify(Object component)

Tests whether the peer requires resize notification. Peers which perform geometry management should override this to return true. When true, resizeNotify() will be called when browser window is resized.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

_positionItem

private Object _positionItem(Object item,
                             Object size,
                             Object shift,
                             Object zIndex,
                             Object vertical,
                             Object valign,
                             Object halign,
                             Object overlayOpacity,
                             Object showOverlay)

Parameters:

item
size
shift
zIndex
vertical
valign
halign
overlayOpacity
showOverlay

Return:

Object

_positionSiblings

private Object _positionSiblings(Object selectedItem,
                                 Object selectedZIndex,
                                 Object vertical,
                                 Object valign,
                                 Object halign,
                                 Object previous)

Parameters:

selectedItem
selectedZIndex
vertical
valign
halign
previous

Return:

Object

_positionThumbAndSpinInfo

private Object _positionThumbAndSpinInfo(Object itemIndex)

Parameters:

itemIndex

Return:

Object

_queueFetchEvent

private Object _queueFetchEvent(Object renderOnly,
                                Object subtype,
                                Object index,
                                Object key)

Parameters:

renderOnly
subtype
index
key

Return:

Object

_queueResizeNotifyOnDisplayedChildren

private Object _queueResizeNotifyOnDisplayedChildren()

Return:

Object

_removePlaceholders

private Object _removePlaceholders()

Return:

Object

ReplaceDomElement

protected Object ReplaceDomElement(HTMLElement newElement,
                                   HTMLElement oldElement)

Replaces the a dom element contained in this peer. The dom element might be a child (or descendent).

Parameters:

newElement	-	the new dom element
oldElement	-	the old dom element

Return:

Object

Overrides:

AdfRichUIPeer.replaceDomElement(AdfUIComponent, HTMLElement, HTMLElement)

_replaceWithDataBlock

private Object _replaceWithDataBlock(Object dataBody,
                                     Object newBlock,
                                     Object fetchIndex)

Parameters:

dataBody
newBlock
fetchIndex

Return:

Object

ResizeNotify

protected Object ResizeNotify(Object oldWidth,
                              Object oldHeight,
                              Object newWidth,
                              Object newHeight)

Called to notify the peer of resize activity. Only called if peer overrides needsResizeNotify() to return true.

Parameters:

oldWidth
oldHeight
newWidth
newHeight

Return:

Object

Overrides:

AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)

_resizeNotifyAfterAnimate

private Object _resizeNotifyAfterAnimate()

Return:

Object

_scrollByAmount

private Object _scrollByAmount(Object scrollAmount,
                               Object forcePercentBased)

Parameters:

scrollAmount
forcePercentBased

Return:

Object

scrollToRowIndex

public Object scrollToRowIndex(Number rowIndex,
                               Function callback)

Scrolls the carousel to the row identified by the rowIndex.

Parameters:

rowIndex	-	the row index to scroll to.
callback	-	the callback function to call after scroll is completed.

Return:

Object

_setCursor

private static Object _setCursor(Object elem,
                                 Object cur)

Parameters:

elem
cur

Return:

Object

_setEventRootToCurrentItem

private Object _setEventRootToCurrentItem(Object key,
                                          Object evt)

Parameters:

key
evt

Return:

Object

_setupInitialCompactOrSmallPositions

private Object _setupInitialCompactOrSmallPositions(Object domElement,
                                                    Object id,
                                                    Object controlArea)

Parameters:

domElement
id
controlArea

Return:

Object

_setupInitialFullPositions

private Object _setupInitialFullPositions(Object domElement,
                                          Object id)

Parameters:

domElement
id

Return:

Object

_setupInitialNonePositions

private Object _setupInitialNonePositions(Object domElement,
                                          Object id)

Parameters:

domElement
id

Return:

Object

_setupInitialPositions

private Object _setupInitialPositions(Object component,
                                      Object domElement)

Attempts to set up the initial posisions of the main elements of this component.

Parameters:

component	-	Component that this peer will be associated with
domElement	-	Root DOM element of this peer

Return:

Object

_sizeDataBody

private Object _sizeDataBody(Object dataBody,
                             Object outerWidth,
                             Object outerHeight)

Parameters:

dataBody
outerWidth
outerHeight

Return:

Object

_sizeDataBodyForSelectedWrapperElement

private Object _sizeDataBodyForSelectedWrapperElement(Object selectedWrapper,
                                                      Object animationAlreadyStopped)

Spin animations

Parameters:

selectedWrapper
animationAlreadyStopped

Return:

Object

_spinAnimationComplete

private static Object _spinAnimationComplete(Object obj)

Parameters:

obj

Return:

Object

_startFetch

private Object _startFetch(Object subtype,
                           Object index,
                           Object key,
                           Object delay,
                           Object renderOnly)

Parameters:

subtype
index
key
delay
renderOnly

Return:

Object

_stopAnimation

private Object _stopAnimation(Object resizeForSelected,
                              Object selectedWrapperOverride)

Parameters:

resizeForSelected
selectedWrapperOverride

Return:

Object

TruncateClientId

protected Object TruncateClientId(Object component,
                                  Object descendantComponent,
                                  Object childClientId,
                                  Object skipArray)

Remove the first id fragment after the carousel id when creating absolute scoped ids

Parameters:

component
descendantComponent
childClientId
skipArray

Return:

Object

Overrides:

AdfRichUIPeer.TruncateClientId(Object, Object, Object, Object)

_undoSpin

private Object _undoSpin(Object block)

Parameters:

block

Return:

Object

_unregisterNode

private Object _unregisterNode(Object node)

Parameters:

node

Return:

Object

_updateComponentStartAndRowProperties

private Object _updateComponentStartAndRowProperties(Object component,
                                                     Object startRow,
                                                     Object numRows)

Parameters:

component
startRow
numRows

Return:

Object

_updateCurrentItemKey

private Object _updateCurrentItemKey(String key,
                                     Boolean ignoreValidation)

Updates the current item key to the new key. This also sets the component property and queues a spin event.

Parameters:

key	-	the new current item key
ignoreValidation	-	if the currentItemKey is being set after a data fetch, for e.g. because of a long jump etc we do not need to the validation etc. Default value = true

Return:

Object

_updateFetchIntersectionItem

private Object _updateFetchIntersectionItem(Object itemWrapper,
                                            Object iteration,
                                            Object count,
                                            Object oldBlockStart,
                                            Object oldBlockEnd,
                                            Object newBlockStart,
                                            Object newBlockEnd)

Parameters:

itemWrapper
iteration
count
oldBlockStart
oldBlockEnd
newBlockStart
newBlockEnd

Return:

Object

_updateHoverState

private Object _updateHoverState(Object target)

Used for both touch and mouse, this will start/stop a popout

Parameters:

target

-

element which is the event target to determine what to popout or if to hide it

Return:

Object

_updateSelectedItemClass

private Object _updateSelectedItemClass(Object newCurrentItemComponent)

Parameters:

newCurrentItemComponent

Return:

Object

_updateSpinInfoDiv

private Object _updateSpinInfoDiv(Object itemNumber)

Parameters:

itemNumber

Return:

Object

_updateTextForNewCurrentItemKey

private Object _updateTextForNewCurrentItemKey(Object key)

Parameters:

key

Return:

Object

_updateTransientDragPosition

private Object _updateTransientDragPosition(Object desiredPercent)

Parameters:

desiredPercent

Return:

Object