OracleJavaScript API Reference for Oracle ADF Faces

 

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

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

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.screenReader.AdfDhtmlTablePeer
                           |
                           +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlTreeTablePeer
Direct Known Subclasses:
AdfDhtmlTreePeer

public class AdfDhtmlTreeTablePeer
extends AdfDhtmlTablePeer
TreeTable peer class



Field Summary

private static Object
_CLIENT_ANCESTOR_PATH
private static Object
_COLLAPSED_NODE_KEY
private static Object
_DEFAULT_FIRST_VISIBLE
private static Object
_DEFAULT_VISIBLE_ROWS
private static Object
_DISCLOSURE_ICON_ID
private static Object
_EXPANDED_NODE_KEY
private static Object
_FIRST_VISIBLE_KEY
private static Object
_INDENT_PADDING
private static Object
_KEY_PATH_SEPARATOR
public static Object
NODE_COLLAPSE_ROW_MARGIN
public static Object
NODE_DEPTH_ATTR
private static Object
_NODE_IMAGE_ATTR
private static Object
_NODE_STAMP_COLUMN
public static Object
READ_ONLY
private static Object
_SELECTED_CLASS
public static Object
TREE_FLAGS_ATTR
private static Object
_TREE_TABLE_ICON_ANIM
private static Object
_TREE_TABLE_ICON_COLLAPSED
private static Object
_TREE_TABLE_ICON_EXPANDED
private static Object
_TREE_TABLE_ICON_LEAF
private static Object
_TREE_TABLE_ICON_STYLE_ANIM
private static Object
_TREE_TABLE_ICON_STYLE_COLLAPSED
private static Object
_TREE_TABLE_ICON_STYLE_EXPANDED
private static Object
_TREE_TABLE_ICON_STYLE_LEAF
private static Object
_TREE_TABLE_ICON_STYLE_SELECTOR
private static Object
_TREE_UP_MARKER
private static Object
_VISIBLE_ROWS_KEY


Fields inherited from oracle.adfinternal.view.js.laf.dhtml.screenReader.AdfDhtmlTablePeer

DETAIL_STAMP_DIALOG_ID, SELECT_ID, SELECTALL_KEY_PROPERTY


Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS


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

constructor, superclass


Fields inherited from org.ecmascript.object.Object

prototype


Constructor Summary

public
AdfDhtmlTreeTablePeer()
TreeTable peer class


Method Summary

private Object
_animateDeletedRows(Object deletedElems, Object parentRow, Object animDuration)
private Object
_animateInsertedBlock(Object newBlock, Object animDuration)
protected Object
BeginHandleDataBlocks()
Overridable hook for subclasses.
protected Object
BlockDeleted()
protected Object
BlockInserted(Object block, Object startRow, Object numRows)
private Object
_clearCurrency()
protected Object
ComponentDisclosedRowKeysChanged(Object component, Object domElement, Object newValue, Object oldValue)
protected Object
ComponentRemoved(Object component)
Clean up the peer because it's component is being removed.
protected Object
ContextMenuClosed(Object componentEvent, Object popup)
protected Object
ContextMenuOpened(Object componentEvent, Object popup)
public Object
discloseAll(Object rowKey, Object expand)
protected Object
FetchCompleted()
Method invoked after the fetch has been completed
private Object
_findChildList(Object parentKey, Object includeParent)
private Object
_findLastTokenAfterCollapse(Object collapsedItems)
Find the token for the last visible node in the view port after a collapse
private Object
_findRowKeyByIndexPath(Object indexPath)
finds a client-side rowKey (token) by child index path.
Object
__getCurrency()
public Object
getDepth(Object rowKey)
Get the depth (indentation level) of a node by rowKey
protected Object
GetDisclosureAnimationDuration()
private Object
_getDisclosureIcon(Object element)
Returns the override disclosure image, if one is found.
private Object
_getDisclosureIconInCell(Object cell)
private Object
_getDisclosureImageFromRowKey(Object rowKey)
private Object
_getDisclosureImageId(Object rowKey)
private Object
_getFillerDataBlocksFromDeleteBlock(Object node)
protected Object
GetIconNames(Object component)
protected Object
GetIconStyleNames(Object component)
private Object
_getNodeStampCell(Object row)
public Object
getNodeStampColumn()
protected Object
GetRowContextMenuId(Object rowKey)
Returns the id of the popup used to display the row context menu
private Object
_getTotalRemovedHeight(Object collapsedItems)
private Object
_getTreeUtils()
public Object
goUp()
protected Object
HandleCollapse(Object node, Object start, Object remainingBlocks)
protected Object
HandleComponentClick(Object componentEvent)
Click handler to process disclosure
protected Object
HandleComponentCollapseEvent(Object collapsedItems)
protected Object
HandleComponentKeyDown(Object componentEvent)
protected Object
HandleComponentMouseDown(Object componentEvent)
Click handler to process disclosure
protected Object
HandleExpand(Object node, Object size, Object remainingBlocks)
protected Object
HandleRowContextMenu(Object domEvent, Object rowKey, Object row, Object alignElement, Object alignHint)
protected Object
HandleTableBodyArrowLeftRight(Object arrowLeft, Object ctrlKey, Object shiftKey)
public Object
hasPathStamp()
Determines if the tree has a pathStamp facet
protected static Object
InitSubclass()
protected Object
InsertActiveRow(Object message, Object type)
private static Object
_insertBlockAnimationComplete(Object callbackObj)
private Object
_isChildOf(Object parentKey, Object childKey)
Is childKey a child of parentKey?
private Object
_isDisclosure(Object target)
public Object
isLeaf(Object rowKey)
Given a rowKey, determines if a node is a leaf node
public Object
isMultiRoot()
Determines if the tree is multi-rooted
protected Object
IsNodeStampCell(Object cell)
Tests whether the specified element is a node stamp cell.
private Object
_isParentInSet(Object keySet, Object childKey)
Is the parent of the childKey in the keySet
public Object
isSelectorIconVisible()
Determines if the hierarchical selector icon is shown
public Object
queueSortEvent(Object rowKey, Object sortOrder)
protected Object
RemoveActiveRow(Object message)
private Object
_resetTreeRow(Object tr, Object level, Object rowKey)
private Object
_saveCurrency(Object currency)
private Object
_setDisclosureIcon(Object element, Object disclosed)
Sets the disclosure icon to disclosed or undisclosed, as specified.
protected Object
SetFirst(Object first)
Overridable method to set first visible row
private Object
_setLeafIcon(Object element)
Sets the node's icon to the leaf icon (which by default is no icon).
private Object
_setRowHeaderFocus(Object rowKey)
Set focus to the row header (if any) for the row identified by rowKey
protected Object
SetRows(Object rows)
Overridable method to set visible rows
public Object
showAsTop(Object rowKey)
Object
__triggerSortEvent(Object componentEvent, Object sortOrder)


Methods inherited from oracle.adfinternal.view.js.laf.dhtml.screenReader.AdfDhtmlTablePeer

canDeliverSelectionEvent, ChildVisibilityChanged, closeDetailStampDialogOnOK, ComponentFirstChanged, ComponentSelectedRowKeysChanged, FindRowByKey, GetAssociatedComponent, GetFirst, GetPanelCollectionPeer, GetRowKeyAndRow, getRowKeyForEvent, GetRows, GetViewPort, HandleComponentDialog, HandleComponentPopupClosed, HandleDomChange, InitDomElement, IsContextMenuSelect, isDisclosureFetchPending, isHeightAutoSized, needsChildVisibilityChanges, needsResizeNotify, ProcessPushData, QueueRangeChangeEvent, ReplaceDomElement, ResizeNotify, SetCursor, SupportsFocusRowNavigation


Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, BindToComponent, cancelAllPopups, cancelPopup, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, domReplaceNotify, DomReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, Init, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, PopupClosed, processPushData, registerKeyStroke, replaceDomElement, resizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren


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

getDefaultDragRecognizer, getParentPeer, initiateDrag, isVisible


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

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


Field Detail


_CLIENT_ANCESTOR_PATH

private static Object _CLIENT_ANCESTOR_PATH

_COLLAPSED_NODE_KEY

private static Object _COLLAPSED_NODE_KEY

_DEFAULT_FIRST_VISIBLE

private static Object _DEFAULT_FIRST_VISIBLE

_DEFAULT_VISIBLE_ROWS

private static Object _DEFAULT_VISIBLE_ROWS

_DISCLOSURE_ICON_ID

private static Object _DISCLOSURE_ICON_ID

_EXPANDED_NODE_KEY

private static Object _EXPANDED_NODE_KEY

_FIRST_VISIBLE_KEY

private static Object _FIRST_VISIBLE_KEY

_INDENT_PADDING

private static Object _INDENT_PADDING

_KEY_PATH_SEPARATOR

private static Object _KEY_PATH_SEPARATOR

NODE_COLLAPSE_ROW_MARGIN

public static Object NODE_COLLAPSE_ROW_MARGIN

NODE_DEPTH_ATTR

public static Object NODE_DEPTH_ATTR

_NODE_IMAGE_ATTR

private static Object _NODE_IMAGE_ATTR

_NODE_STAMP_COLUMN

private static Object _NODE_STAMP_COLUMN

READ_ONLY

public static Object READ_ONLY

_SELECTED_CLASS

private static Object _SELECTED_CLASS

TREE_FLAGS_ATTR

public static Object TREE_FLAGS_ATTR

_TREE_TABLE_ICON_ANIM

private static Object _TREE_TABLE_ICON_ANIM

_TREE_TABLE_ICON_COLLAPSED

private static Object _TREE_TABLE_ICON_COLLAPSED

_TREE_TABLE_ICON_EXPANDED

private static Object _TREE_TABLE_ICON_EXPANDED

_TREE_TABLE_ICON_LEAF

private static Object _TREE_TABLE_ICON_LEAF

_TREE_TABLE_ICON_STYLE_ANIM

private static Object _TREE_TABLE_ICON_STYLE_ANIM

_TREE_TABLE_ICON_STYLE_COLLAPSED

private static Object _TREE_TABLE_ICON_STYLE_COLLAPSED

_TREE_TABLE_ICON_STYLE_EXPANDED

private static Object _TREE_TABLE_ICON_STYLE_EXPANDED

_TREE_TABLE_ICON_STYLE_LEAF

private static Object _TREE_TABLE_ICON_STYLE_LEAF

_TREE_TABLE_ICON_STYLE_SELECTOR

private static Object _TREE_TABLE_ICON_STYLE_SELECTOR

_TREE_UP_MARKER

private static Object _TREE_UP_MARKER

_VISIBLE_ROWS_KEY

private static Object _VISIBLE_ROWS_KEY

Constructor Detail


AdfDhtmlTreeTablePeer

public AdfDhtmlTreeTablePeer()

TreeTable peer class

Method Detail


_animateDeletedRows

private Object _animateDeletedRows(Object deletedElems,
                                   Object parentRow,
                                   Object animDuration)

Parameters:
deletedElems    
parentRow    
animDuration    
Return:
Object

_animateInsertedBlock

private Object _animateInsertedBlock(Object newBlock,
                                     Object animDuration)

Parameters:
newBlock    
animDuration    
Return:
Object

BeginHandleDataBlocks

protected Object BeginHandleDataBlocks()

Overridable hook for subclasses. This is called before any new data blocks from the server are handled

Return:
Object

BlockDeleted

protected Object BlockDeleted()

Return:
Object

BlockInserted

protected Object BlockInserted(Object block,
                               Object startRow,
                               Object numRows)

Parameters:
block    
startRow    
numRows    
Return:
Object

_clearCurrency

private Object _clearCurrency()

Return:
Object

ComponentDisclosedRowKeysChanged

protected Object ComponentDisclosedRowKeysChanged(Object component,
                                                  Object domElement,
                                                  Object newValue,
                                                  Object oldValue)

Parameters:
component    
domElement    
newValue    
oldValue    
Return:
Object
Overrides:
AdfDhtmlTablePeer.ComponentDisclosedRowKeysChanged(Object, Object, Object, Object)

ComponentRemoved

protected Object ComponentRemoved(Object component)

Clean up the peer because it's component is being removed.

Parameters:
component    
Return:
Object
Overrides:
AdfUIPeer.componentRemoved(AdfUIComponent)

ContextMenuClosed

protected Object ContextMenuClosed(Object componentEvent,
                                   Object popup)

Parameters:
componentEvent    
popup    
Return:
Object
Overrides:
AdfDhtmlTablePeer.ContextMenuClosed(Object, Object)

ContextMenuOpened

protected Object ContextMenuOpened(Object componentEvent,
                                   Object popup)

Parameters:
componentEvent    
popup    
Return:
Object
Overrides:
AdfDhtmlTablePeer.ContextMenuOpened(Object, Object)

discloseAll

public Object discloseAll(Object rowKey,
                          Object expand)

Parameters:
rowKey    
expand    
Return:
Object

FetchCompleted

protected Object FetchCompleted()

Method invoked after the fetch has been completed

Return:
Object

_findChildList

private Object _findChildList(Object parentKey,
                              Object includeParent)

Parameters:
parentKey    
includeParent    
Return:
Object

_findLastTokenAfterCollapse

private Object _findLastTokenAfterCollapse(Object collapsedItems)

Find the token for the last visible node in the view port after a collapse

Parameters:
collapsedItems    
Return:
Object

_findRowKeyByIndexPath

private Object _findRowKeyByIndexPath(Object indexPath)

finds a client-side rowKey (token) by child index path. indexPath should be in this form 1_3_9. Where the numbers indicate server-side indexes into child collections. This function works with automation enabled where indexPaths are sent down from the server.

Parameters:
indexPath    
Return:
Object

__getCurrency

Object __getCurrency()

Return:
Object

getDepth

public Object getDepth(Object rowKey)

Get the depth (indentation level) of a node by rowKey

Parameters:
rowKey    
Return:
Object

GetDisclosureAnimationDuration

protected Object GetDisclosureAnimationDuration()

Return:
Object

_getDisclosureIcon

private Object _getDisclosureIcon(Object element)

Returns the override disclosure image, if one is found.

Parameters:
element    
Return:
Object

_getDisclosureIconInCell

private Object _getDisclosureIconInCell(Object cell)

Parameters:
cell    
Return:
Object

_getDisclosureImageFromRowKey

private Object _getDisclosureImageFromRowKey(Object rowKey)

Parameters:
rowKey    
Return:
Object

_getDisclosureImageId

private Object _getDisclosureImageId(Object rowKey)

Parameters:
rowKey    
Return:
Object

_getFillerDataBlocksFromDeleteBlock

private Object _getFillerDataBlocksFromDeleteBlock(Object node)

Parameters:
node    
Return:
Object

GetIconNames

protected Object GetIconNames(Object component)

Parameters:
component    
Return:
Object

GetIconStyleNames

protected Object GetIconStyleNames(Object component)

Parameters:
component    
Return:
Object

_getNodeStampCell

private Object _getNodeStampCell(Object row)

Parameters:
row    
Return:
Object

getNodeStampColumn

public Object getNodeStampColumn()

Return:
Object

GetRowContextMenuId

protected Object GetRowContextMenuId(Object rowKey)

Returns the id of the popup used to display the row context menu

Parameters:
rowKey    
Return:
Object

_getTotalRemovedHeight

private Object _getTotalRemovedHeight(Object collapsedItems)

Parameters:
collapsedItems    
Return:
Object

_getTreeUtils

private Object _getTreeUtils()

Return:
Object

goUp

public Object goUp()

Return:
Object

HandleCollapse

protected Object HandleCollapse(Object node,
                                Object start,
                                Object remainingBlocks)

Parameters:
node    
start    
remainingBlocks    
Return:
Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Click handler to process disclosure

Parameters:
componentEvent    
Return:
Object
Overrides:
AdfDhtmlTablePeer.HandleComponentClick(Object)

HandleComponentCollapseEvent

protected Object HandleComponentCollapseEvent(Object collapsedItems)

Parameters:
collapsedItems    
Return:
Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

Parameters:
componentEvent    
Return:
Object
Overrides:
AdfDhtmlTablePeer.HandleComponentKeyDown(Object)

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

Click handler to process disclosure

Parameters:
componentEvent    
Return:
Object
Overrides:
AdfDhtmlTablePeer.HandleComponentMouseDown(Object)

HandleExpand

protected Object HandleExpand(Object node,
                              Object size,
                              Object remainingBlocks)

Parameters:
node    
size    
remainingBlocks    
Return:
Object

HandleRowContextMenu

protected Object HandleRowContextMenu(Object domEvent,
                                      Object rowKey,
                                      Object row,
                                      Object alignElement,
                                      Object alignHint)

Parameters:
domEvent    
rowKey    
row    
alignElement    
alignHint    
Return:
Object
Overrides:
AdfDhtmlTablePeer.HandleRowContextMenu(Object, Object, Object, Object, Object)

HandleTableBodyArrowLeftRight

protected Object HandleTableBodyArrowLeftRight(Object arrowLeft,
                                               Object ctrlKey,
                                               Object shiftKey)

Parameters:
arrowLeft    
ctrlKey    
shiftKey    
Return:
Object

hasPathStamp

public Object hasPathStamp()

Determines if the tree has a pathStamp facet

Return:
Object

InitSubclass

protected static Object InitSubclass()

Return:
Object
Overrides:
AdfDhtmlTablePeer.InitSubclass()

InsertActiveRow

protected Object InsertActiveRow(Object message,
                                 Object type)

Parameters:
message    
type    
Return:
Object

_insertBlockAnimationComplete

private static Object _insertBlockAnimationComplete(Object callbackObj)

Parameters:
callbackObj    
Return:
Object

_isChildOf

private Object _isChildOf(Object parentKey,
                          Object childKey)

Is childKey a child of parentKey? Making assumptions about the format of the structured token

Parameters:
parentKey    
childKey    
Return:
Object

_isDisclosure

private Object _isDisclosure(Object target)

Parameters:
target    
Return:
Object

isLeaf

public Object isLeaf(Object rowKey)

Given a rowKey, determines if a node is a leaf node

Parameters:
rowKey    
Return:
Object

isMultiRoot

public Object isMultiRoot()

Determines if the tree is multi-rooted

Return:
Object

IsNodeStampCell

protected Object IsNodeStampCell(Object cell)

Tests whether the specified element is a node stamp cell.

Parameters:
cell    
Return:
Object

_isParentInSet

private Object _isParentInSet(Object keySet,
                              Object childKey)

Is the parent of the childKey in the keySet

Parameters:
keySet    
childKey    
Return:
Object

isSelectorIconVisible

public Object isSelectorIconVisible()

Determines if the hierarchical selector icon is shown

Return:
Object

queueSortEvent

public Object queueSortEvent(Object rowKey,
                             Object sortOrder)

Parameters:
rowKey    
sortOrder    
Return:
Object

RemoveActiveRow

protected Object RemoveActiveRow(Object message)

Parameters:
message    
Return:
Object

_resetTreeRow

private Object _resetTreeRow(Object tr,
                             Object level,
                             Object rowKey)

Parameters:
tr    
level    
rowKey    
Return:
Object

_saveCurrency

private Object _saveCurrency(Object currency)

Parameters:
currency    
Return:
Object

_setDisclosureIcon

private Object _setDisclosureIcon(Object element,
                                  Object disclosed)

Sets the disclosure icon to disclosed or undisclosed, as specified. In the default case, this is accomplished by changing the icon-style styleClass. If the user has overwritten the default icons, then this is accomplished by swapping the icons.

Parameters:
element    
disclosed    
Return:
Object

SetFirst

protected Object SetFirst(Object first)

Overridable method to set first visible row

Parameters:
first    
Return:
Object
Overrides:
AdfDhtmlTablePeer.SetFirst(Object)

_setLeafIcon

private Object _setLeafIcon(Object element)

Sets the node's icon to the leaf icon (which by default is no icon). In the default case, this is accomplished by changing the icon-style styleClass. If the user has overwritten the default icons, then this is accomplished by swapping the icons.

Parameters:
element    
Return:
Object

_setRowHeaderFocus

private Object _setRowHeaderFocus(Object rowKey)

Set focus to the row header (if any) for the row identified by rowKey

Parameters:
rowKey    
Return:
Object

SetRows

protected Object SetRows(Object rows)

Overridable method to set visible rows

Parameters:
rows    
Return:
Object

showAsTop

public Object showAsTop(Object rowKey)

Parameters:
rowKey    
Return:
Object

__triggerSortEvent

Object __triggerSortEvent(Object componentEvent,
                           Object sortOrder)

Parameters:
componentEvent    
sortOrder    
Return:
Object

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

 

Generated on 2009.09.25 03:44 UTC
Copyright (c) 1998, 2009, Oracle and/or its affiliates. All rights reserved.