JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

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

Field Summary

private Object	_animDuration
public static Object	DW_SUB_ID
private static Object	_FETCH_DELAY_TIMEOUT
private static Object	_FETCH_MORE_ITEM_COUNT
private Object	_fetchId
private static Object	_INPUT_REGEXP
private Object	_isScreenReaderMode
private Object	_isVertical
private static Object	_ITEM_PADDING
public static Object	MISSING_AFTER
public static Object	MISSING_BEFORE
private static Object	_NEEDS_REFRESH_ATTRIBUTE
public static Object	NO_BLOCKS
private static Object	_ROW_KEY
private Object	_setupInitialPositions
private Object	_unavailableRowIndex
private static Object	_UNDO_FETCH_ATTRIBUTE
private Object	_useOpacity
public static Object	VIEWPORT_SATISFIED

Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlCarouselPeer()

Method Summary

private Object	_addAfter(Object databody, Object delay, Object isScroll)
private Object	_addBefore(Object databody, Object delay, Object isScroll)
private Object	_addDataBlockItems(Object databody, Object node, Object prepend)
private Object	_addEmptyTextToDataBody(Object databody, Object newElement) Adds the empty text to the data body
private Object	_addInvalidDataBlock(Object oldElement, Object block, Object databody) If we get block of data that is not valid because the user has been jumping around randomly add all 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
private Object	_adjustRowCountFromResponse(Object databody, Object node)
private Object	_allRowsAvailableOnClient(Object block) Determine if all rows are available locally on the client
private Object	_animateRowsForNewSelectedWrapperElement(Object selectedWrapper, Object oldCurrentItemKey)
private Object	_cancelPendingFetch()
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.
protected Object	ChildVisibilityChanged(Object childComponent, Object childDomElement, Object childVisible) Override to PPR the component when a column is hidden
private Object	_collectClientTokens(Object cacheType)
protected Object	ComponentCurrentItemKeyChanged(Object component, Object domElement, Object newValue, Object oldValue) Selection Logic (Row and Column)
protected Object	ComponentRemoved(AdfUIComponent component) Handles the removal of a component.
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.
public String	convertLocatorToClientId(AdfUIComponent component, Number rowIndex) Function to replace client id fragments when converting an absolute locator to clientId.
private Object	_currentItemTextUpdate(Object itemClientId)
private Object	_delayedNavigate(Object subtype, Object index, Object key, Object renderOnly)
private Object	_delayedResizeNotifyOnDisplayedChildren()
private Object	_deleteOffscreenItems(Object databody, Object deletePrevious)
private Object	_displayStatus(Object text)
protected Object	DomReplaceNotify(Object domNode) Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.
private Object	_doResizeNotifyOnDisplayedChildren(Object component)
private Object	_fillViewPort(Object databody, Object delay, Object isScroll) Scrolling and virtualization
private static Object	_findFirstChildByTagName(Object parent, Object name)
private Object	_findRowByKey(String rowKey, Boolean firstByDefault) Returns the row and the index associated with the rowKey in the dom structure
private Object	_finishDatabodyDrag(Object domEvent, Object deltaX, Object deltaY)
private Object	_finishThumbDrag(Object domEvent, Object deltaX, Object deltaY)
private Object	_getAuxShiftSizeAndOpacity(Object offsetIndex) Given the offset index of the auxillary item, caculates its shift, size and the opacity.
private static Object	_getChildBySubId(Object parent, Object sub)
private Object	_getControlAreaDiv(Object rootDomElement)
private Object	_getCurrentPercent()
private Object	_getDatabody(Object rootDomElement)
private Object	_getElemBySubId(Object sub, Object rootDomElement) Gets an element belonging to this peer based on the root DOM element.
private Object	_getHalignLeft(Object vertical, Object halign, Object dbWidth, Object itemSize, Object shift)
private Object	_getItemTextDiv(Object clientId)
private Object	_getNextRowKeyAndRow(Object selectedRowKey) Returns the rowkey and the row after the selected row.
private Object	_getPreviousRowKeyAndRow(Object selectedRowKey) Returns the rowkey and the row before the selected row.
private Object	_getRowIndexFromThumbPos()
private Object	_getRowKeyAndRow(Object domElement, Object rootDomElement) Returns the row key attribute and the row from a dom element.
private Object	_getSpinControlDiv(Object clientId)
private Object	_getSpinInfoDiv(Object clientId)
private Object	_getStatusMessage()
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.
private Object	_getValignTop(Object vertical, Object valign, Object dbHeight, Object itemSize, Object shift)
private Object	_grabFocus() Focus handling
protected Object	HandleComponentClick(Object componentEvent)
protected Object	HandleComponentKeyDown(Object componentEvent) keyboard handling
protected Object	HandleComponentMouseDown(Object componentEvent)
protected Object	HandleComponentMouseOut(Object componentEvent) Event Handlers
protected Object	HandleComponentMouseUp(Object componentEvent)
private Object	_handleDatabodyDragPositioning(Object domEvent, Object deltaX, Object deltaY)
private Object	_handleDataBodySelectStart(Object evt)
private Object	_handleDataCallback(Object node, Object pendingFetch, Object fetchIndex, Object pendingRenderOnly)
private Object	_handleItemClick(Object evt, Object rowKey, Object row)
private Object	_handleLongJump(Object databody, Object index, Object delay, Object isScroll)
private static Object	_handleMouseWheel(Object evt)
private static Object	_handleNextClick(Object domEvent)
private static Object	_handlePreviousClick(Object domEvent)
private Object	_handleTabKeyDown(Object eventTarget, Object shiftKey)
private Object	_handleThumbDragPositioning(Object domEvent, Object deltaX, Object deltaY)
private Object	_handleTouchMovement(Number deltaX, Number deltaY) Handler invoked by an AdfTouchMoveManager when the user performs a dual touch movement on the data body.
private Object	_hideStatus()
private Object	_incrementCarouselPosition() Controller for the main increment or decrement function.
protected Object	InitDomElement(Object component, Object domElement) Initialize the associated domElement when the peer is created.
private Object	_initiateSpinEndAnimation()
private Object	_initiateSpinNextAnimation()
private Object	_initiateSpinPercentAnimation(Object desiredPercent)
private Object	_initiateSpinPreviousAnimation()
private Object	_initiateSpinSpecificExistingItemAnimation(Object desiredRowKey, Object desiredRow)
private Object	_initiateSpinStartAnimation()
private Object	_initMouseHoldIncrementRepeat() Callback function, started by an interval.
private Object	_initNewBlock(Object node, Object start, Object size)
protected static Object	InitSubclass() Registers component handlers.
private Object	_initVirtualization(Object firstBlock, Object alreadyInserted)
private Object	_isImmediateContentDelivery(Object component)
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)
private static Object	_isRTL()
private Object	_isTargetCellEditable(Object node)
private Object	_isViewportSatisfied(Object databody)
public Object	needsChildVisibilityChanges(Object component) The AdfDhtmlCarouselPeer cares about child visibility changes in order to redraw when columns are hidden/shown
public Object	needsResizeNotify(Object component) Tests whether the peer requires resize notification.
private Object	_positionItem(Object item, Object size, Object shift, Object zIndex, Object vertical, Object valign, Object halign, Object overlayOpacity, Object showOverlay)
private Object	_positionSiblings(Object selectedItem, Object selectedZIndex, Object vertical, Object valign, Object halign, Object previous)
private Object	_positionThumbAndSpinInfo(Object itemIndex)
private Object	_queueFetchEvent(Object renderOnly, Object subtype, Object index, Object key)
private Object	_queueResizeNotifyOnDisplayedChildren()
protected Object	ReplaceDomElement(HTMLElement newElement, HTMLElement oldElement) Replaces the a dom element contained in this peer.
private Object	_replaceWithDataBlock(Object databody, Object node, Object fetchIndex)
protected Object	ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight) Called to notify the peer of resize activity.
private Object	_resizeNotifyAfterAnimate()
private Object	_scrollByAmount(Object scrollAmount, Object forcePercentBased)
private static Object	_setCursor(Object elem, Object cur)
private Object	_setEventRootToCurrentItem(Object key, Object evt)
private Object	_setupInitialCompactOrSmallPositions(Object domElement, Object id, Object controlArea)
private Object	_setupInitialFullPositions(Object domElement, Object id)
private Object	_setupInitialPositions(Object component, Object domElement) Attempts to set up the initial posisions of the main elements of this component.
private Object	_sizeDatabody(Object databody, Object outerWidth, Object outerHeight)
private Object	_sizeDatabodyForSelectedWrapperElement(Object selectedWrapper) Spin animations
private static Object	_spinAnimationComplete(Object obj)
private Object	_startFetch(Object subtype, Object index, Object key, Object delay, Object renderOnly)
private Object	_stopAnimation(Object selectedWrapperOverride)
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
private Object	_undoSpin(Object block)
private Object	_unregisterNode(Object node)
private Object	_updateCurrentItemKey(String key, Boolean ignoreValidation) Updates the current item key to the new key.
private Object	_updateSpinInfoDiv(Object itemNumber)
private Object	_updateTextForNewCurrentItemKey(Object key)

Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, BindToComponent, cancelAllPopups, cancelPopup, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, domReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, Init, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, resizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

Methods inherited from oracle.adf.view.js.base.AdfUIPeer

getDefaultDragRecognizer, getParentPeer, initiateDrag, isVisible

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString

Field Detail

_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

_isScreenReaderMode

private Object _isScreenReaderMode

_isVertical

private Object _isVertical

_ITEM_PADDING

private static Object _ITEM_PADDING

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

_ROW_KEY

private static Object _ROW_KEY

_setupInitialPositions

private Object _setupInitialPositions

_unavailableRowIndex

private Object _unavailableRowIndex

_UNDO_FETCH_ATTRIBUTE

private static Object _UNDO_FETCH_ATTRIBUTE

_useOpacity

private Object _useOpacity

VIEWPORT_SATISFIED

public static Object VIEWPORT_SATISFIED

Constructor Detail

AdfDhtmlCarouselPeer

public AdfDhtmlCarouselPeer()

Method Detail

_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 node,
Object prepend)

Parameters:

databody
node
prepend

Return:

Object

_addEmptyTextToDataBody

private Object _addEmptyTextToDataBody(Object databody,
Object newElement)

Adds the empty text to the data body

Parameters:

databody
newElement

Return:

Object

_addInvalidDataBlock

private Object _addInvalidDataBlock(Object oldElement,
Object block,
Object databody)

If we get block of data that is not valid because the user has been jumping around randomly add all 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
block
databody

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

_animateRowsForNewSelectedWrapperElement

private Object _animateRowsForNewSelectedWrapperElement(Object selectedWrapper,
Object oldCurrentItemKey)

Parameters:

selectedWrapper
oldCurrentItemKey

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)

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

_currentItemTextUpdate

private Object _currentItemTextUpdate(Object itemClientId)

Parameters:

itemClientId

Return:

Object

_delayedNavigate

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

Parameters:

subtype
index
key
renderOnly

Return:

Object

_delayedResizeNotifyOnDisplayedChildren

private Object _delayedResizeNotifyOnDisplayedChildren()

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

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

_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

_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

_getNextRowKeyAndRow

private Object _getNextRowKeyAndRow(Object selectedRowKey)

Returns the rowkey and the row after the selected row.

Parameters:

selectedRowKey

Return:

Object

_getPreviousRowKeyAndRow

private Object _getPreviousRowKeyAndRow(Object selectedRowKey)

Returns the rowkey and the row before the selected row.

Parameters:

selectedRowKey

Return:

Object

_getRowIndexFromThumbPos

private Object _getRowIndexFromThumbPos()

Return:

Object

_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

_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

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

Event Handlers

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

_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

_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(Object desiredPercent)

Parameters:

desiredPercent

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

_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

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 node,
Object fetchIndex)

Parameters:

databody
node
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

_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

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

Spin animations

Parameters:

selectedWrapper

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

Parameters:

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

_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

_updateSpinInfoDiv

private Object _updateSpinInfoDiv(Object itemNumber)

Parameters:

itemNumber

Return:

Object

_updateTextForNewCurrentItemKey

private Object _updateTextForNewCurrentItemKey(Object key)

Parameters:

key

Return:

Object

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD