JavaScript API Reference for Oracle ADF Faces

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

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

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

public class AdfRichTree
extends AdfUITree

Represents an interactive tree component.

Field Summary

Fields inherited from org.apache.myjs.trinidad.component.AdfUITree

DISCLOSURE_LISTENER_KEY, LOCAL_DISCLOSURE_STATE

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary

public

AdfRichTree() Represents an interactive tree component.

Method Summary

public String	getAccessibleName() Returns the localized String that represents the purpose of this Object.
public Object	getActiveRowKey() Get function for attribute for 'activeRowKey'.
public Boolean	getClearTokenCacheOnPPR() Get function for attribute for 'clearTokenCacheOnPPR'.
public String	getContentDelivery() Get function for attribute for 'contentDelivery'.
public String	getContextMenuId() Get function for attribute for 'contextMenuId'.
public Boolean	getContextMenuSelect() Get function for attribute for 'contextMenuSelect'.
public String	getDisplayRow() Get function for attribute for 'displayRow'.
public Object	getDisplayRowKey() Get function for attribute for 'displayRowKey'.
public String	getEditingMode() Get function for attribute for 'editingMode'.
public String	getEmptyText() Get function for attribute for 'emptyText'.
public Boolean	getExpandAllEnabled() Get function for attribute for 'expandAllEnabled'.
public Number	getFetchSize() Get function for attribute for 'fetchSize'.
public String	getInlineStyle() Get function for attribute for 'inlineStyle'.
public Number	getRowIndex(String rowKey) Returns the index of a row identified by rowKey.
public String	getRowKey(Number index) Returns the rowKey to identify a row based on its index.
public String	getRowSelection() Get function for attribute for 'rowSelection'.
public Number	getScrollLeft() Get function for attribute for 'scrollLeft'.
public Number	getScrollTop() Get function for attribute for 'scrollTop'.
public Object	getScrollTopRowKey() Get function for attribute for 'scrollTopRowKey'.
public String	getShortDesc() Get function for attribute for 'shortDesc'.
public String	getStyleClass() Get function for attribute for 'styleClass'.
public String	getSummary() Get function for attribute for 'summary'.
public Object	getUnsecure() Get function for attribute for 'unsecure'.
public Boolean	getVisible() Get function for attribute for 'visible'.
public void	setActiveRowKey(Object newActiveRowKey) Set function for attribute 'ActiveRowKey'.
public void	setClearTokenCacheOnPPR(Boolean newClearTokenCacheOnPPR) Set function for attribute 'ClearTokenCacheOnPPR'.
public void	setContentDelivery(String newContentDelivery) Set function for attribute 'ContentDelivery'.
public void	setContextMenuId(String newContextMenuId) Set function for attribute 'ContextMenuId'.
public void	setContextMenuSelect(Boolean newContextMenuSelect) Set function for attribute 'ContextMenuSelect'.
public void	setDisplayRow(String newDisplayRow) Set function for attribute 'DisplayRow'.
public void	setDisplayRowKey(Object newDisplayRowKey) Set function for attribute 'DisplayRowKey'.
public void	setEditingMode(String newEditingMode) Set function for attribute 'EditingMode'.
public void	setEmptyText(String newEmptyText) Set function for attribute 'EmptyText'.
public void	setExpandAllEnabled(Boolean newExpandAllEnabled) Set function for attribute 'ExpandAllEnabled'.
public void	setFetchSize(Number newFetchSize) Set function for attribute 'FetchSize'.
public void	setInlineStyle(String newInlineStyle) Set function for attribute 'InlineStyle'.
public void	setRowSelection(String newRowSelection) Set function for attribute 'RowSelection'.
public void	setScrollLeft(Number newScrollLeft) Set function for attribute 'ScrollLeft'.
public void	setScrollTop(Number newScrollTop) Set function for attribute 'ScrollTop'.
public void	setScrollTopRowKey(Object newScrollTopRowKey) Set function for attribute 'ScrollTopRowKey'.
public void	setShortDesc(String newShortDesc) Set function for attribute 'ShortDesc'.
public void	setStyleClass(String newStyleClass) Set function for attribute 'StyleClass'.
public void	setSummary(String newSummary) Set function for attribute 'Summary'.
public void	setVisible(Boolean newVisible) Set function for attribute 'Visible'.

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

DeliverDerivedPropertyEvents, findComponent, GetChanges, getDisclosedRowKeys, getFocusListener, getFocusRowKey, getImmediate, getInitiallyExpanded, getRowDisclosureListener, getSelectedRowKeys, getSelectionListener, getValue, Init, isPathExpanded, isPathSelected, setDisclosedRowKey, setDisclosedRowKeys, setSelectedRowKeys, setValue

Field Detail

Constructor Detail

AdfRichTree

public AdfRichTree()

Represents an interactive tree component.

Method Detail

getAccessibleName

public String getAccessibleName()

Returns the localized String that represents the purpose of this Object. The Component is allowed to determine this name in any way it sees fit, including basing the value on properties of the component.
There is no guarantee that elements without full client-components will have a good accessible name, even if the appropriate attributes are set on the server.

Return:

String - The accessible name of the component or null if none is available.

getActiveRowKey

public Object getActiveRowKey()

Get function for attribute for 'activeRowKey'.

Return:

Object - ActiveRowKey

getClearTokenCacheOnPPR

public Boolean getClearTokenCacheOnPPR()

Get function for attribute for 'clearTokenCacheOnPPR'.

Return:

Boolean - ClearTokenCacheOnPPR

getContentDelivery

public String getContentDelivery()

Get function for attribute for 'contentDelivery'.

Return:

String - ContentDelivery

getContextMenuId

public String getContextMenuId()

Get function for attribute for 'contextMenuId'.

Return:

String - ContextMenuId

getContextMenuSelect

public Boolean getContextMenuSelect()

Get function for attribute for 'contextMenuSelect'.

Return:

Boolean - ContextMenuSelect

getDisplayRow

public String getDisplayRow()

Get function for attribute for 'displayRow'.

Return:

String - DisplayRow

getDisplayRowKey

public Object getDisplayRowKey()

Get function for attribute for 'displayRowKey'.

Return:

Object - DisplayRowKey

getEditingMode

public String getEditingMode()

Get function for attribute for 'editingMode'.

Return:

String - EditingMode

getEmptyText

public String getEmptyText()

Get function for attribute for 'emptyText'.

Return:

String - EmptyText

getExpandAllEnabled

public Boolean getExpandAllEnabled()

Get function for attribute for 'expandAllEnabled'.

Return:

Boolean - ExpandAllEnabled

getFetchSize

public Number getFetchSize()

Get function for attribute for 'fetchSize'.

Return:

Number - FetchSize

getInlineStyle

public String getInlineStyle()

Get function for attribute for 'inlineStyle'.

Return:

String - InlineStyle

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)

getRowSelection

public String getRowSelection()

Get function for attribute for 'rowSelection'.

Return:

String - RowSelection

getScrollLeft

public Number getScrollLeft()

Get function for attribute for 'scrollLeft'.

Return:

Number - ScrollLeft

getScrollTop

public Number getScrollTop()

Get function for attribute for 'scrollTop'.

Return:

Number - ScrollTop

getScrollTopRowKey

public Object getScrollTopRowKey()

Get function for attribute for 'scrollTopRowKey'.

Return:

Object - ScrollTopRowKey

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

getSummary

public String getSummary()

Get function for attribute for 'summary'.

Return:

String - Summary

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

getVisible

public Boolean getVisible()

Get function for attribute for 'visible'.

Return:

Boolean - Visible

setActiveRowKey

public void setActiveRowKey(Object newActiveRowKey)

Set function for attribute 'ActiveRowKey'.

Parameters:

newActiveRowKey

Return:

void - No Value returned

setClearTokenCacheOnPPR

public void setClearTokenCacheOnPPR(Boolean newClearTokenCacheOnPPR)

Set function for attribute 'ClearTokenCacheOnPPR'.

Parameters:

newClearTokenCacheOnPPR

Return:

void - No Value returned

setContentDelivery

public void setContentDelivery(String newContentDelivery)

Set function for attribute 'ContentDelivery'.

Parameters:

newContentDelivery

Return:

void - No Value returned

setContextMenuId

public void setContextMenuId(String newContextMenuId)

Set function for attribute 'ContextMenuId'.

Parameters:

newContextMenuId

Return:

void - No Value returned

setContextMenuSelect

public void setContextMenuSelect(Boolean newContextMenuSelect)

Set function for attribute 'ContextMenuSelect'.

Parameters:

newContextMenuSelect

Return:

void - No Value returned

setDisplayRow

public void setDisplayRow(String newDisplayRow)

Set function for attribute 'DisplayRow'.

Parameters:

newDisplayRow

Return:

void - No Value returned

setDisplayRowKey

public void setDisplayRowKey(Object newDisplayRowKey)

Set function for attribute 'DisplayRowKey'.

Parameters:

newDisplayRowKey

Return:

void - No Value returned

setEditingMode

public void setEditingMode(String newEditingMode)

Set function for attribute 'EditingMode'.

Parameters:

newEditingMode

Return:

void - No Value returned

setEmptyText

public void setEmptyText(String newEmptyText)

Set function for attribute 'EmptyText'.

Parameters:

newEmptyText

Return:

void - No Value returned

setExpandAllEnabled

public void setExpandAllEnabled(Boolean newExpandAllEnabled)

Set function for attribute 'ExpandAllEnabled'.

Parameters:

newExpandAllEnabled

Return:

void - No Value returned

setFetchSize

public void setFetchSize(Number newFetchSize)

Set function for attribute 'FetchSize'.

Parameters:

newFetchSize

Return:

void - No Value returned

setInlineStyle

public void setInlineStyle(String newInlineStyle)

Set function for attribute 'InlineStyle'.

Parameters:

newInlineStyle

Return:

void - No Value returned

setRowSelection

public void setRowSelection(String newRowSelection)

Set function for attribute 'RowSelection'.

Parameters:

newRowSelection

Return:

void - No Value returned

setScrollLeft

public void setScrollLeft(Number newScrollLeft)

Set function for attribute 'ScrollLeft'.

Parameters:

newScrollLeft

Return:

void - No Value returned

setScrollTop

public void setScrollTop(Number newScrollTop)

Set function for attribute 'ScrollTop'.

Parameters:

newScrollTop

Return:

void - No Value returned

setScrollTopRowKey

public void setScrollTopRowKey(Object newScrollTopRowKey)

Set function for attribute 'ScrollTopRowKey'.

Parameters:

newScrollTopRowKey

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

setSummary

public void setSummary(String newSummary)

Set function for attribute 'Summary'.

Parameters:

newSummary

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