# JavaScript API Reference for Oracle ADF Faces

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

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 number` | `getAutoHeightRows()` Get function for attribute for 'autoHeightRows'.
`public string` | `getBlockRowNavigationOnError()` Get function for attribute for 'blockRowNavigationOnError'.
`public boolean` | `getClearTokenCacheOnPPR()` Get function for attribute for 'clearTokenCacheOnPPR'.
`public Number` | `getClientRowCount()` Returns the number of rows that can be iterated on the client.
`public Number` | `getClientStartRowIndex()` Returns the index of the first row that can be iterated on the client.
`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 Object` | `getFocusRowKey()` Get function for attribute for 'focusRowKey'.
`public boolean` | `getInitiallyExpanded()` Get function for attribute for 'initiallyExpanded'.
`public string` | `getInlineStyle()` Get function for attribute for 'inlineStyle'.
`public number` | `getMaxClientRows()` Get function for attribute for 'maxClientRows'.
`public number` | `getNonScrollableRows()` Get function for attribute for 'nonScrollableRows'.
`public Number` | `getRowCount()` Returns the number of rows in the underlying collection on the server.
`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` | `getSelectionEventDelay()` Get function for attribute for 'selectionEventDelay'.
`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 Object` | `scrollToRowIndex(Object index, Object callback)` Scroll the tree to the specified index, fire the callback once the tree has been updated
`public void` | `setActiveRowKey(Object newActiveRowKey)` Set function for attribute 'ActiveRowKey'.
`public void` | `setAutoHeightRows(number newAutoHeightRows)` Set function for attribute 'AutoHeightRows'.
`public void` | `setBlockRowNavigationOnError(string newBlockRowNavigationOnError)` Set function for attribute 'BlockRowNavigationOnError'.
`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` | `setFocusRowKey(Object newFocusRowKey)` Set function for attribute 'FocusRowKey'.
`public void` | `setInitiallyExpanded(boolean newInitiallyExpanded)` Set function for attribute 'InitiallyExpanded'.
`public void` | `setInlineStyle(string newInlineStyle)` Set function for attribute 'InlineStyle'.
`public void` | `setMaxClientRows(number newMaxClientRows)` Set function for attribute 'MaxClientRows'.
`public void` | `setNonScrollableRows(number newNonScrollableRows)` Set function for attribute 'NonScrollableRows'.
`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` | `setSelectionEventDelay(string newSelectionEventDelay)` Set function for attribute 'SelectionEventDelay'.
`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'.
`public Object` | `simulateSelectRows(String rowKeyList, String operation)` Simulate a user selecting one or more rows from the user interface.

### Methods inherited from org.apache.myjs.trinidad.component.AdfUITree
`DeliverDerivedPropertyEvents, findComponent, GetChanges, getDisclosedRowKeys, getFocusListener, getImmediate, 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

### getAutoHeightRows

`public number getAutoHeightRows()`
  Get function for attribute for 'autoHeightRows'.
  Return:
    `number` - AutoHeightRows

### getBlockRowNavigationOnError

`public string getBlockRowNavigationOnError()`
  Get function for attribute for 'blockRowNavigationOnError'.
  Return:
    `string` - BlockRowNavigationOnError

### getClearTokenCacheOnPPR

`public boolean getClearTokenCacheOnPPR()`
  Get function for attribute for 'clearTokenCacheOnPPR'.
  Return:
    `boolean` - ClearTokenCacheOnPPR

### getClientRowCount

`public Number getClientRowCount()`
  Returns the number of rows that can be iterated on the client.
  Return:
    `Number` - the number of rows on the client.
  See also:
    `getClientStartRowIndex()`

### getClientStartRowIndex

`public Number getClientStartRowIndex()`
  Returns the index of the first row that can be iterated on the client.
  Return:
    `Number` - the index of the first row on the client, or -1 if there is no row.
  See also:
    `getClientRowCount()`

### 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

### getFocusRowKey

`public Object getFocusRowKey()`
  Get function for attribute for 'focusRowKey'.
  Return:
    `Object` - FocusRowKey
  Overrides:
    `AdfUITree.getFocusRowKey()`

### getInitiallyExpanded

`public boolean getInitiallyExpanded()`
  Get function for attribute for 'initiallyExpanded'.
  Return:
    `boolean` - InitiallyExpanded
  Overrides:
    `AdfUITree.getInitiallyExpanded()`

### getInlineStyle

`public string getInlineStyle()`
  Get function for attribute for 'inlineStyle'.
  Return:
    `string` - InlineStyle

### getMaxClientRows

`public number getMaxClientRows()`
  Get function for attribute for 'maxClientRows'.
  Return:
    `number` - MaxClientRows

### getNonScrollableRows

`public number getNonScrollableRows()`
  Get function for attribute for 'nonScrollableRows'.
  Return:
    `number` - NonScrollableRows

### getRowCount

`public Number getRowCount()`
  Returns the number of rows in the underlying collection on the server.
  Return:
    `Number` - the number of rows on the server.

### 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

### getSelectionEventDelay

`public string getSelectionEventDelay()`
  Get function for attribute for 'selectionEventDelay'.
  Return:
    `string` - SelectionEventDelay

### 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

### scrollToRowIndex

`public Object scrollToRowIndex(Object index,
Object callback)`
  Scroll the tree to the specified index, fire the callback once the tree has been updated
  Parameters:

    `index` |  |
    `callback` |  |

  Return:
    `Object`

### setActiveRowKey

`public void setActiveRowKey(Object newActiveRowKey)`
  Set function for attribute 'ActiveRowKey'.
  Parameters:

    `newActiveRowKey` |  |

  Return:
    `void` - No Value returned

### setAutoHeightRows

`public void setAutoHeightRows(number newAutoHeightRows)`
  Set function for attribute 'AutoHeightRows'.
  Parameters:

    `newAutoHeightRows` |  |

  Return:
    `void` - No Value returned

### setBlockRowNavigationOnError

`public void setBlockRowNavigationOnError(string newBlockRowNavigationOnError)`
  Set function for attribute 'BlockRowNavigationOnError'.
  Parameters:

    `newBlockRowNavigationOnError` |  |

  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

### setFocusRowKey

`public void setFocusRowKey(Object newFocusRowKey)`
  Set function for attribute 'FocusRowKey'.
  Parameters:

    `newFocusRowKey` |  |

  Return:
    `void` - No Value returned

### setInitiallyExpanded

`public void setInitiallyExpanded(boolean newInitiallyExpanded)`
  Set function for attribute 'InitiallyExpanded'.
  Parameters:

    `newInitiallyExpanded` |  |

  Return:
    `void` - No Value returned

### setInlineStyle

`public void setInlineStyle(string newInlineStyle)`
  Set function for attribute 'InlineStyle'.
  Parameters:

    `newInlineStyle` |  |

  Return:
    `void` - No Value returned

### setMaxClientRows

`public void setMaxClientRows(number newMaxClientRows)`
  Set function for attribute 'MaxClientRows'.
  Parameters:

    `newMaxClientRows` |  |

  Return:
    `void` - No Value returned

### setNonScrollableRows

`public void setNonScrollableRows(number newNonScrollableRows)`
  Set function for attribute 'NonScrollableRows'.
  Parameters:

    `newNonScrollableRows` |  |

  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

### setSelectionEventDelay

`public void setSelectionEventDelay(string newSelectionEventDelay)`
  Set function for attribute 'SelectionEventDelay'.
  Parameters:

    `newSelectionEventDelay` |  |

  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

### simulateSelectRows

`public Object simulateSelectRows(String rowKeyList,
String operation)`
  Simulate a user selecting one or more rows from the user interface.
  If more than one row is specified, it is up to the test to make sure the component allows multiple row selection.
  Valid values for operation are:
  "replace" - replace current selection with the rows specified by rowKeyArray.
  "toggle" - toggle the selection state of the rows specified by rowKeyArray.
  Parameters:

    `rowKeyList` | - | - a comma-separated list of rowkeys that specifies the rows to operate on
    `operation` | - | - the operation to perform. "replace" is the default if no valid value is passed for this parameter.

  Return:
    `Object`

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

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.