JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.component.rich.data
Class AdfRichCarousel

org.ecmascript.object.Object
   |
   +--org.apache.myjs.trinidad.component.AdfUICollection
         |
         +--org.apache.myjs.trinidad.component.AdfUIIterator
               |
               +--oracle.adf.view.js.component.rich.data.AdfRichCarousel

public class AdfRichCarousel
extends AdfUIIterator

CAROUSEL_SPIN_LISTENER_KEY

public static Object CAROUSEL_SPIN_LISTENER_KEY

Property key for the carousel spin listener.

Deprecated: this key should not be used

AdfRichCarousel

public AdfRichCarousel()

The carousel component displays a spinning series of items based on rows of a collection model.

findComponent

public Object findComponent(Object scopedId,
                            Object rowKey)

AdfRichCarousel provides this overload of AdfUIComponent.findComponent() which takes an (optional) row key. When the row key is specified, AdfRichCarousel.findComponent() returns the stamped component instance for the specified row. Note that the actual row key value may be transformed by the rich client framework such that the client-side value of the row key may not have any resemblance to the server-side row key. As such, only row keys served up by the client-side framework (e.g. row keys obtained from spin events) should be passed to AdfRichCarousel.findComponent(). Also note that the lifecycle of stamped client-side components may be limited in scope. For large data sets, the AdfRichCarousel component may discard components which are no longer visible. In such cases, AdfRichCarousel.findComponent() will return null. Applications which need access to component state for rows which are no longer present on the client must return to the server to access this information.

Parameters:

scopedId
rowKey

Return:

Object

getAuxiliaryOffset

public Object getAuxiliaryOffset()

Get function for attribute for 'auxiliaryOffset'.

Return:

Object - AuxiliaryOffset

getAuxiliaryPopOut

public string getAuxiliaryPopOut()

Get function for attribute for 'auxiliaryPopOut'.

Return:

string - AuxiliaryPopOut

getAuxiliaryScale

public Object getAuxiliaryScale()

Get function for attribute for 'auxiliaryScale'.

Return:

Object - AuxiliaryScale

getCarouselSpinListener

public Object getCarouselSpinListener()

Get function for attribute for 'carouselSpinListener'.

Return:

Object - CarouselSpinListener

getContentDelivery

public string getContentDelivery()

Get function for attribute for 'contentDelivery'.

Return:

string - ContentDelivery

getControlArea

public string getControlArea()

Get function for attribute for 'controlArea'.

Return:

string - ControlArea

getCurrentItemKey

public Object getCurrentItemKey()

Get function for attribute for 'currentItemKey'.

Return:

Object - CurrentItemKey

getDisabled

public boolean getDisabled()

Get function for attribute for 'disabled'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

boolean - Disabled

getDisplayItems

public string getDisplayItems()

Get function for attribute for 'displayItems'.

Return:

string - DisplayItems

getEmptyText

public string getEmptyText()

Get function for attribute for 'emptyText'.

Return:

string - EmptyText

getFetchSize

public number getFetchSize()

Get function for attribute for 'fetchSize'.

Return:

number - FetchSize

getFirst

public number getFirst()

Get function for attribute for 'first'.

Return:

number - First

Overrides:

AdfUIIterator.getFirst()

getHalign

public string getHalign()

Get function for attribute for 'halign'.

Return:

string - Halign

getImmediate

public boolean getImmediate()

Get function for attribute for 'immediate'.

Return:

boolean - Immediate

getInlineStyle

public string getInlineStyle()

Get function for attribute for 'inlineStyle'.

Return:

string - InlineStyle

getOrientation

public string getOrientation()

Get function for attribute for 'orientation'.

Return:

string - Orientation

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)

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)

getRows

public number getRows()

Get function for attribute for 'rows'.

Return:

number - Rows

Overrides:

AdfUIIterator.getRows()

getShortDesc

public string getShortDesc()

Get function for attribute for 'shortDesc'.

Return:

string - ShortDesc

getStyleClass

public string getStyleClass()

Get function for attribute for 'styleClass'.

Return:

string - StyleClass

getUnsecure

public Object getUnsecure()

Get function for attribute for 'unsecure'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

Object - Unsecure

getValign

public string getValign()

Get function for attribute for 'valign'.

Return:

string - Valign

getVisible

public boolean getVisible()

Get function for attribute for 'visible'.

Return:

boolean - Visible

isEventRoot

public Object isEventRoot()

Returns true so that events can be limited to within the carousel.

Return:

Object

scrollToRowIndex

public Object scrollToRowIndex(Number index,
                               Function callback)

Scrolls the carousel to the row identified by the rowIndex.

Parameters:

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

Return:

Object

setAuxiliaryOffset

public void setAuxiliaryOffset(Object newAuxiliaryOffset)

Set function for attribute 'AuxiliaryOffset'.

Parameters:

newAuxiliaryOffset

Return:

void - No Value returned

setAuxiliaryPopOut

public void setAuxiliaryPopOut(string newAuxiliaryPopOut)

Set function for attribute 'AuxiliaryPopOut'.

Parameters:

newAuxiliaryPopOut

Return:

void - No Value returned

setAuxiliaryScale

public void setAuxiliaryScale(Object newAuxiliaryScale)

Set function for attribute 'AuxiliaryScale'.

Parameters:

newAuxiliaryScale

Return:

void - No Value returned

setCarouselSpinListener

public void setCarouselSpinListener(Object newCarouselSpinListener)

Set function for attribute 'CarouselSpinListener'.

Parameters:

newCarouselSpinListener

Return:

void - No Value returned

setContentDelivery

public void setContentDelivery(string newContentDelivery)

Set function for attribute 'ContentDelivery'.

Parameters:

newContentDelivery

Return:

void - No Value returned

setControlArea

public void setControlArea(string newControlArea)

Set function for attribute 'ControlArea'.

Parameters:

newControlArea

Return:

void - No Value returned

setCurrentItemKey

public void setCurrentItemKey(Object newCurrentItemKey)

Set function for attribute 'CurrentItemKey'.

Parameters:

newCurrentItemKey

Return:

void - No Value returned

setDisplayItems

public void setDisplayItems(string newDisplayItems)

Set function for attribute 'DisplayItems'.

Parameters:

newDisplayItems

Return:

void - No Value returned

setEmptyText

public void setEmptyText(string newEmptyText)

Set function for attribute 'EmptyText'.

Parameters:

newEmptyText

Return:

void - No Value returned

setFetchSize

public void setFetchSize(number newFetchSize)

Set function for attribute 'FetchSize'.

Parameters:

newFetchSize

Return:

void - No Value returned

setFirst

public void setFirst(number newFirst)

Set function for attribute 'First'.

Parameters:

newFirst

Return:

void - No Value returned

Overrides:

AdfUIIterator.setFirst(number)

setHalign

public void setHalign(string newHalign)

Set function for attribute 'Halign'.

Parameters:

newHalign

Return:

void - No Value returned

setImmediate

public void setImmediate(boolean newImmediate)

Set function for attribute 'Immediate'.

Parameters:

newImmediate

Return:

void - No Value returned

setInlineStyle

public void setInlineStyle(string newInlineStyle)

Set function for attribute 'InlineStyle'.

Parameters:

newInlineStyle

Return:

void - No Value returned

setOrientation

public void setOrientation(string newOrientation)

Set function for attribute 'Orientation'.

Parameters:

newOrientation

Return:

void - No Value returned

setRows

public void setRows(number newRows)

Set function for attribute 'Rows'.

Parameters:

newRows

Return:

void - No Value returned

Overrides:

AdfUIIterator.setRows(number)

setShortDesc

public void setShortDesc(string newShortDesc)

Set function for attribute 'ShortDesc'.

Parameters:

newShortDesc

Return:

void - No Value returned

setStyleClass

public void setStyleClass(string newStyleClass)

Set function for attribute 'StyleClass'.

Parameters:

newStyleClass

Return:

void - No Value returned

setValign

public void setValign(string newValign)

Set function for attribute 'Valign'.

Parameters:

newValign

Return:

void - No Value returned

setVisible

public void setVisible(boolean newVisible)

Set function for attribute 'Visible'.

Parameters:

newVisible

Return:

void - No Value returned