OracleJavaScript API Reference for Oracle ADF Faces

 

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

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfTreeUtils

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfTreeUtils

public class AdfTreeUtils
extends AdfObject
Utility class used by the default and screen reader tree/treeTable peers Mostly contains shared context menu handling fucntions



Field Summary

private static Object
_COLLAPSE_ALL_BELOW_ID
private static Object
_DEFAULT_CONTEXT_MENU_POPUP_ID
private static Object
_EXPAND_ALL_BELOW_ID
private static Object
_EXPAND_ID
private static Object
_HAS_PATH_STAMP_BIT
private static Object
_HSELECTOR_ROW_KEY
private static Object
_IS_MULTI_ROOT_BIT
private static Object
_IS_SELECTOR_ICON_VISIBLE
private Object
_peer
private static Object
_SELECTOR_ICON_ID
public static Object
SELECTOR_IMAGE_ATTR
private static Object
_SELECTOR_POPUP_ID
private static Object
_SHOW_AS_TOP_ID
private static Object
_SORT_ASCENDING_ID
private static Object
_SORT_DESCENDING_ID
private static Object
_SORT_ID


Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass


Fields inherited from org.ecmascript.object.Object

prototype


Constructor Summary

public
AdfTreeUtils(Object peer)
Utility class used by the default and screen reader tree/treeTable peers Mostly contains shared context menu handling fucntions


Method Summary

public Object
addContextMenuEventListeners()
Attach client side context menu listeners
public Object
clearCachedContextMenuItems()
public Object
collapseAllBelowAction(Object componentEvent)
collapse all menu item action handler
public Object
createComponentSubId(Object clientId, Object name)
public Object
expandAction(Object componentEvent)
Expand menu item action handler
public Object
expandAllBelowAction(Object componentEvent)
Expand all menu item action handler
public Object
findContextMenuItems()
public Object
findMenuItemContainer()
public Object
findSelectorItemAndRowKey(Object element)
Given a parent node, find the child dom element and its associated row key attribute inside the selector popup
public Object
getCurrencyFromDomElement(Object domEvent, Object domElement, Object rootDomElement, Object attr)
Returns the attribute attached to the domElement.
public Object
getParentWithAttribute(Object domElem, Object attributeName, Object attributeValue)
Walk up the parent hierarchy and find an element with the given style class
private Object
_getSelectionCount()
public Object
getSelectorIcon()
Get hierarchical selector icon by id
public Object
getSelectorItemRowKey(Object nativeEvent, Object target)
Get the row key associated with the node inside the selector popup
public Object
getSelectorSelectedRowKey()
Return the row key associated with the selected node inside the hierarchical selector popup
private Object
_handleComponentAction(Object componentEvent)
Context menu item action handler
private Object
_handleSelectorPopupClosed(Object componentEvent)
hiererchical selector popup close handler
public Object
hasPathStamp()
Determines if the tree has a pathStamp facet
public Object
hideSelectorPopup()
Hide the iererchical selector popup
protected Object
Init(Object peer)
Initializes the instance.
protected static Object
InitClass()
public Object
isMultiRoot()
Determines if the tree is multi-rooted
public Object
isSelectorIconVisible()
Determines if the hierarchical selector icon is shown
public Object
isSelectorPopupVisible()
Is the hierarchical selector popup visible
public Object
removeContextMenuEventListeners(Object component)
Remove context menu listeners
public Object
selectSelectorPopupItem(Object next)
Select the next/previous node inside the hierarchical selector popup
public Object
setAssociatedDisclosedRowKeys(Object newValue, Object oldValue)
public Object
setupDefaultRowContextMenu(Object isLeaf, Object isExpanded, Object nodeDepth, Object isMultiRoot, Object isFocusRow)
Setup listeners for context menu
public Object
shouldResetMenuEventListeners()
public Object
showAsTopAction(Object componentEvent)
Show as top menu item action handler
public Object
showSelectorPopup()
Display the hierarchical selector popup
public Object
sortAscendingAction(Object componentEvent)
Sort ascending menu item action handler
public Object
sortDescendingAction(Object componentEvent)
Sort descending menu item action handler
public Object
updateContextMenu(Object isLeaf, Object isExpanded, Object nodeDepth, Object isMultiRoot, Object isContextMenuSelect, Object isFocusRow)
Update the status of the context menu items


Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString


Field Detail


_COLLAPSE_ALL_BELOW_ID

private static Object _COLLAPSE_ALL_BELOW_ID

_DEFAULT_CONTEXT_MENU_POPUP_ID

private static Object _DEFAULT_CONTEXT_MENU_POPUP_ID

_EXPAND_ALL_BELOW_ID

private static Object _EXPAND_ALL_BELOW_ID

_EXPAND_ID

private static Object _EXPAND_ID

_HAS_PATH_STAMP_BIT

private static Object _HAS_PATH_STAMP_BIT

_HSELECTOR_ROW_KEY

private static Object _HSELECTOR_ROW_KEY

_IS_MULTI_ROOT_BIT

private static Object _IS_MULTI_ROOT_BIT

_IS_SELECTOR_ICON_VISIBLE

private static Object _IS_SELECTOR_ICON_VISIBLE

_peer

private Object _peer

_SELECTOR_ICON_ID

private static Object _SELECTOR_ICON_ID

SELECTOR_IMAGE_ATTR

public static Object SELECTOR_IMAGE_ATTR

_SELECTOR_POPUP_ID

private static Object _SELECTOR_POPUP_ID

_SHOW_AS_TOP_ID

private static Object _SHOW_AS_TOP_ID

_SORT_ASCENDING_ID

private static Object _SORT_ASCENDING_ID

_SORT_DESCENDING_ID

private static Object _SORT_DESCENDING_ID

_SORT_ID

private static Object _SORT_ID

Constructor Detail


AdfTreeUtils

public AdfTreeUtils(Object peer)

Utility class used by the default and screen reader tree/treeTable peers Mostly contains shared context menu handling fucntions

Parameters:
peer    

Method Detail


addContextMenuEventListeners

public Object addContextMenuEventListeners()

Attach client side context menu listeners

Return:
Object

clearCachedContextMenuItems

public Object clearCachedContextMenuItems()

Return:
Object

collapseAllBelowAction

public Object collapseAllBelowAction(Object componentEvent)

collapse all menu item action handler

Parameters:
componentEvent    
Return:
Object

createComponentSubId

public Object createComponentSubId(Object clientId,
                                   Object name)

Parameters:
clientId    
name    
Return:
Object

expandAction

public Object expandAction(Object componentEvent)

Expand menu item action handler

Parameters:
componentEvent    
Return:
Object

expandAllBelowAction

public Object expandAllBelowAction(Object componentEvent)

Expand all menu item action handler

Parameters:
componentEvent    
Return:
Object

findContextMenuItems

public Object findContextMenuItems()

Return:
Object

findMenuItemContainer

public Object findMenuItemContainer()

Return:
Object

findSelectorItemAndRowKey

public Object findSelectorItemAndRowKey(Object element)

Given a parent node, find the child dom element and its associated row key attribute inside the selector popup

Parameters:
element    
Return:
Object

getCurrencyFromDomElement

public Object getCurrencyFromDomElement(Object domEvent,
                                        Object domElement,
                                        Object rootDomElement,
                                        Object attr)

Returns the attribute attached to the domElement. If necessary, walks up the dom hierarchy to find the element with the given attribute

Parameters:
domEvent    
domElement    
rootDomElement    
attr    
Return:
Object

getParentWithAttribute

public Object getParentWithAttribute(Object domElem,
                                     Object attributeName,
                                     Object attributeValue)

Walk up the parent hierarchy and find an element with the given style class

Parameters:
domElem    
attributeName    
attributeValue    
Return:
Object

_getSelectionCount

private Object _getSelectionCount()

Return:
Object

getSelectorIcon

public Object getSelectorIcon()

Get hierarchical selector icon by id

Return:
Object

getSelectorItemRowKey

public Object getSelectorItemRowKey(Object nativeEvent,
                                    Object target)

Get the row key associated with the node inside the selector popup

Parameters:
nativeEvent    
target    
Return:
Object

getSelectorSelectedRowKey

public Object getSelectorSelectedRowKey()

Return the row key associated with the selected node inside the hierarchical selector popup

Return:
Object

_handleComponentAction

private Object _handleComponentAction(Object componentEvent)

Context menu item action handler

Parameters:
componentEvent    
Return:
Object

_handleSelectorPopupClosed

private Object _handleSelectorPopupClosed(Object componentEvent)

hiererchical selector popup close handler

Parameters:
componentEvent    
Return:
Object

hasPathStamp

public Object hasPathStamp()

Determines if the tree has a pathStamp facet

Return:
Object

hideSelectorPopup

public Object hideSelectorPopup()

Hide the iererchical selector popup

Return:
Object

Init

protected Object Init(Object peer)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:
peer    
Return:
Object
Overrides:
AdfObject.Init()

InitClass

protected static Object InitClass()

Return:
Object

isMultiRoot

public Object isMultiRoot()

Determines if the tree is multi-rooted

Return:
Object

isSelectorIconVisible

public Object isSelectorIconVisible()

Determines if the hierarchical selector icon is shown

Return:
Object

isSelectorPopupVisible

public Object isSelectorPopupVisible()

Is the hierarchical selector popup visible

Return:
Object

removeContextMenuEventListeners

public Object removeContextMenuEventListeners(Object component)

Remove context menu listeners

Parameters:
component    
Return:
Object

selectSelectorPopupItem

public Object selectSelectorPopupItem(Object next)

Select the next/previous node inside the hierarchical selector popup

Parameters:
next    
Return:
Object

setAssociatedDisclosedRowKeys

public Object setAssociatedDisclosedRowKeys(Object newValue,
                                            Object oldValue)

Parameters:
newValue    
oldValue    
Return:
Object

setupDefaultRowContextMenu

public Object setupDefaultRowContextMenu(Object isLeaf,
                                         Object isExpanded,
                                         Object nodeDepth,
                                         Object isMultiRoot,
                                         Object isFocusRow)

Setup listeners for context menu

Parameters:
isLeaf    
isExpanded    
nodeDepth    
isMultiRoot    
isFocusRow    
Return:
Object

shouldResetMenuEventListeners

public Object shouldResetMenuEventListeners()

Return:
Object

showAsTopAction

public Object showAsTopAction(Object componentEvent)

Show as top menu item action handler

Parameters:
componentEvent    
Return:
Object

showSelectorPopup

public Object showSelectorPopup()

Display the hierarchical selector popup

Return:
Object

sortAscendingAction

public Object sortAscendingAction(Object componentEvent)

Sort ascending menu item action handler

Parameters:
componentEvent    
Return:
Object

sortDescendingAction

public Object sortDescendingAction(Object componentEvent)

Sort descending menu item action handler

Parameters:
componentEvent    
Return:
Object

updateContextMenu

public Object updateContextMenu(Object isLeaf,
                                Object isExpanded,
                                Object nodeDepth,
                                Object isMultiRoot,
                                Object isContextMenuSelect,
                                Object isFocusRow)

Update the status of the context menu items

Parameters:
isLeaf    
isExpanded    
nodeDepth    
isMultiRoot    
isContextMenuSelect    
isFocusRow    
Return:
Object

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

 

Generated on 2012.08.25 02:16 UTC
Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.