JavaScript API Reference for Oracle ADF Faces

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

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

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

Field Summary

public static Object

CAROUSEL_SPIN_LISTENER_KEY Copyright (c) 2009, Oracle and/or its affiliates.

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary

public

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

Method Summary

public Object	findComponent(Object scopedId, Object rowKey) AdfRichCarousel provides this overload of AdfUIComponent.findComponent() which takes an (optional) row key.
public Object	getCarouselSpinListener() Get function for attribute for 'carouselSpinListener'.
public String	getContentDelivery() Get function for attribute for 'contentDelivery'.
public String	getControlArea() Get function for attribute for 'controlArea'.
public Object	getCurrentItemKey() Get function for attribute for 'currentItemKey'.
public Boolean	getDisabled() Get function for attribute for 'disabled'.
public String	getDisplayItems() Get function for attribute for 'displayItems'.
public String	getEmptyText() Get function for attribute for 'emptyText'.
public Number	getFetchSize() Get function for attribute for 'fetchSize'.
public String	getHalign() Get function for attribute for 'halign'.
public Boolean	getImmediate() Get function for attribute for 'immediate'.
public String	getInlineStyle() Get function for attribute for 'inlineStyle'.
public String	getOrientation() Get function for attribute for 'orientation'.
public String	getShortDesc() Get function for attribute for 'shortDesc'.
public String	getStyleClass() Get function for attribute for 'styleClass'.
public Object	getUnsecure() Get function for attribute for 'unsecure'.
public String	getValign() Get function for attribute for 'valign'.
public Boolean	getVisible() Get function for attribute for 'visible'.
public Object	isEventRoot() Returns true so that events can be limited to within the carousel.
public void	setCarouselSpinListener(Object newCarouselSpinListener) Set function for attribute 'CarouselSpinListener'.
public void	setContentDelivery(String newContentDelivery) Set function for attribute 'ContentDelivery'.
public void	setControlArea(String newControlArea) Set function for attribute 'ControlArea'.
public void	setCurrentItemKey(Object newCurrentItemKey) Set function for attribute 'CurrentItemKey'.
public void	setDisplayItems(String newDisplayItems) Set function for attribute 'DisplayItems'.
public void	setEmptyText(String newEmptyText) Set function for attribute 'EmptyText'.
public void	setFetchSize(Number newFetchSize) Set function for attribute 'FetchSize'.
public void	setHalign(String newHalign) Set function for attribute 'Halign'.
public void	setImmediate(Boolean newImmediate) Set function for attribute 'Immediate'.
public void	setInlineStyle(String newInlineStyle) Set function for attribute 'InlineStyle'.
public void	setOrientation(String newOrientation) Set function for attribute 'Orientation'.
public void	setShortDesc(String newShortDesc) Set function for attribute 'ShortDesc'.
public void	setStyleClass(String newStyleClass) Set function for attribute 'StyleClass'.
public void	setValign(String newValign) Set function for attribute 'Valign'.
public void	setVisible(Boolean newVisible) Set function for attribute 'Visible'.

Methods inherited from org.apache.myjs.trinidad.component.AdfUIIterator

getFirst, getRows, getValue, setFirst, setRows, setValue

Field Detail

CAROUSEL_SPIN_LISTENER_KEY

public static Object CAROUSEL_SPIN_LISTENER_KEY

Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. The AdfRichCarousel class. Note: This is a "partial" class, the majority of this class is generated.

Constructor Detail

AdfRichCarousel

public AdfRichCarousel()

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

Method Detail

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

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

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

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

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

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

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

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