JavaScript API Reference for Oracle ADF Faces

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

org.apache.myjs.trinidad.component
Class AdfUITree

org.ecmascript.object.Object
   |
   +--org.apache.myjs.trinidad.component.AdfUICollection
         |
         +--org.apache.myjs.trinidad.component.AdfUITree

Direct Known Subclasses:

AdfRichTree, AdfUITreeTable

public class AdfUITree
extends AdfUICollection

Represents an interactive tree component.

Field Summary

public static Object	DISCLOSURE_LISTENER_KEY Component for outputting tree data Note:
public static Object	LOCAL_DISCLOSURE_STATE

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary

public

AdfUITree() Represents an interactive tree component.

Method Summary

protected Object	DeliverDerivedPropertyEvents(Object propName, Object oldValue, Object newValue) Override to fire expansion and selection change events
public Object	findComponent(Object scopedId, Object rowKey) AdfUITree provides this overload of AdfUIComponent.findComponent() which takes an (optional) row key.
protected Object	GetChanges() Override to encode treeState and selectionState
public Object	getDisclosedRowKeys() Get function for attribute for 'disclosedRowKeys'.
public Object	getFocusListener() Get function for attribute for 'focusListener'.
public Object	getFocusRowKey() Get function for attribute for 'focusRowKey'.
public Boolean	getImmediate() Get function for attribute for 'immediate'.
public Boolean	getInitiallyExpanded() Get function for attribute for 'initiallyExpanded'.
public Object	getRowDisclosureListener() Get function for attribute for 'rowDisclosureListener'.
public Object	getSelectedRowKeys() Get function for attribute for 'selectedRowKeys'.
public Object	getSelectionListener() Get function for attribute for 'selectionListener'.
public Object	getValue() Get function for attribute for 'value'.
protected Object	Init(Object componentType, Object clientId, Object properties, Object children, Object facets)
public Object	isPathExpanded(Object rowKey) Returns true if path is expanded
public Object	isPathSelected(Object rowKey) Returns true if path is selected
public Object	setDisclosedRowKey(Object rowKey, Object disclosed) Add/remove the given rowKey to/from the disclosedRowKeys
public void	setDisclosedRowKeys(Object newDisclosedRowKeys) Set function for attribute 'DisclosedRowKeys'.
public void	setSelectedRowKeys(Object newSelectedRowKeys) Set function for attribute 'SelectedRowKeys'.
public void	setValue(Object newValue) Set function for attribute 'Value'.

Field Detail

DISCLOSURE_LISTENER_KEY

public static Object DISCLOSURE_LISTENER_KEY

Component for outputting tree data Note: This is a "partial" class, the majority of this class is generated.

LOCAL_DISCLOSURE_STATE

public static Object LOCAL_DISCLOSURE_STATE

Constructor Detail

AdfUITree

public AdfUITree()

Represents an interactive tree component.

Method Detail

DeliverDerivedPropertyEvents

protected Object DeliverDerivedPropertyEvents(Object propName,
Object oldValue,
Object newValue)

Override to fire expansion and selection change events

Parameters:

propName
oldValue
newValue

Return:

Object

findComponent

public Object findComponent(Object scopedId,
Object rowKey)

AdfUITree provides this overload of AdfUIComponent.findComponent() which takes an (optional) row key. When the row key is specified, AdfUITree.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 (eg. row keys obtained from selection events) should be passed to AdfUITree.findComponent(). Also note that the lifecycle of stamped client-side components may be limited in scope. For large data sets, the AdfUITree component may discard components which are no longer visible. In such cases, AdfUITree.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

GetChanges

protected Object GetChanges()

Override to encode treeState and selectionState

Return:

Object

getDisclosedRowKeys

public Object getDisclosedRowKeys()

Get function for attribute for 'disclosedRowKeys'.

Return:

Object - DisclosedRowKeys

getFocusListener

public Object getFocusListener()

Get function for attribute for 'focusListener'. 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 - FocusListener

getFocusRowKey

public Object getFocusRowKey()

Get function for attribute for 'focusRowKey'. 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 - FocusRowKey

getImmediate

public Boolean getImmediate()

Get function for attribute for 'immediate'. 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 - Immediate

getInitiallyExpanded

public Boolean getInitiallyExpanded()

Get function for attribute for 'initiallyExpanded'. 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 - InitiallyExpanded

getRowDisclosureListener

public Object getRowDisclosureListener()

Get function for attribute for 'rowDisclosureListener'. 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 - RowDisclosureListener

getSelectedRowKeys

public Object getSelectedRowKeys()

Get function for attribute for 'selectedRowKeys'.

Return:

Object - SelectedRowKeys

getSelectionListener

public Object getSelectionListener()

Get function for attribute for 'selectionListener'. 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 - SelectionListener

getValue

public Object getValue()

Get function for attribute for 'value'.

Return:

Object - Value

Init

protected Object Init(Object componentType,
Object clientId,
Object properties,
Object children,
Object facets)

Parameters:

componentType
clientId
properties
children
facets

Return:

Object

isPathExpanded

public Object isPathExpanded(Object rowKey)

Returns true if path is expanded

Parameters:

rowKey

Return:

Object

isPathSelected

public Object isPathSelected(Object rowKey)

Returns true if path is selected

Parameters:

rowKey

Return:

Object

setDisclosedRowKey

public Object setDisclosedRowKey(Object rowKey,
Object disclosed)

Add/remove the given rowKey to/from the disclosedRowKeys

Parameters:

rowKey
disclosed

Return:

Object

setDisclosedRowKeys

public void setDisclosedRowKeys(Object newDisclosedRowKeys)

Set function for attribute 'DisclosedRowKeys'.

Parameters:

newDisclosedRowKeys

Return:

void - No Value returned

setSelectedRowKeys

public void setSelectedRowKeys(Object newSelectedRowKeys)

Set function for attribute 'SelectedRowKeys'.

Parameters:

newSelectedRowKeys

Return:

void - No Value returned

setValue

public void setValue(Object newValue)

Set function for attribute 'Value'.

Parameters:

newValue

Return:

void - No Value returned

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