JavaScript API Reference for Oracle ADF Faces

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

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.rich.AdfDhtmlPanelCollectionPeer

public class AdfDhtmlPanelCollectionPeer
extends AdfRichUIPeer

_AGGREGATED_CHILD_ID

private static Object _AGGREGATED_CHILD_ID

_aggregatedChild

private Object _aggregatedChild

_ALL_TEXT

private static Object _ALL_TEXT

_AUTO_HEIGHT_BOTTOM_ID

private static Object _AUTO_HEIGHT_BOTTOM_ID

_AUTO_HEIGHT_CENTER_ID

private static Object _AUTO_HEIGHT_CENTER_ID

_AUTO_HEIGHT_TOP_ID

private static Object _AUTO_HEIGHT_TOP_ID

_COL_IDS_WITH_MENUS_KEY

private static Object _COL_IDS_WITH_MENUS_KEY

_COLLAPSE_ALL_BELOW_MENUITEM_ID

private static Object _COLLAPSE_ALL_BELOW_MENUITEM_ID

_COLLAPSE_ALL_MENUITEM_ID

private static Object _COLLAPSE_ALL_MENUITEM_ID

_COLUMN_CONTEXT_MENU_ID

private static Object _COLUMN_CONTEXT_MENU_ID

_COLUMNS_FROZEN_COUNT_ID

private static Object _COLUMNS_FROZEN_COUNT_ID

_COLUMNS_FROZEN_TEXT

private static Object _COLUMNS_FROZEN_TEXT

_COLUMNS_FROZEN_TEXT_ID

private static Object _COLUMNS_FROZEN_TEXT_ID

_COLUMNS_HIDDEN_COUNT_ID

private static Object _COLUMNS_HIDDEN_COUNT_ID

_COLUMNS_HIDDEN_TEXT

private static Object _COLUMNS_HIDDEN_TEXT

_COLUMNS_HIDDEN_TEXT_ID

private static Object _COLUMNS_HIDDEN_TEXT_ID

_COLUMNS_MENU_ID

private static Object _COLUMNS_MENU_ID

_COLUMNS_SHOWALL_MENUITEM_ID

private static Object _COLUMNS_SHOWALL_MENUITEM_ID

_COLUMNS_SHOWCOLUMN_MENUITEM_ID

private static Object _COLUMNS_SHOWCOLUMN_MENUITEM_ID

_COLUMNS_SHOWMORE_MENUITEM_ID

private static Object _COLUMNS_SHOWMORE_MENUITEM_ID

_DETACH_DIALOG_CONTAINER_ID

private static Object _DETACH_DIALOG_CONTAINER_ID

_DETACH_DIALOG_POPUP_ID

private static Object _DETACH_DIALOG_POPUP_ID

_DETACH_DIALOG_WRAPPER_ID

private static Object _DETACH_DIALOG_WRAPPER_ID

_DETACH_MENUITEM_ID

private static Object _DETACH_MENUITEM_ID

_DETACH_TOOLBARITEM_ID

private static Object _DETACH_TOOLBARITEM_ID

_DIALOG_TYPE_REORDER_COLS

private static Object _DIALOG_TYPE_REORDER_COLS

_DIALOG_TYPE_RESIZE_COL

private static Object _DIALOG_TYPE_RESIZE_COL

_DIALOG_TYPE_SHOW_COLS

private static Object _DIALOG_TYPE_SHOW_COLS

_DIALOG_TYPE_SORT

private static Object _DIALOG_TYPE_SORT

_DIALOG_TYPE_SORT_ID

private static Object _DIALOG_TYPE_SORT_ID

_EXPAND_ALL_BELOW_MENUITEM_ID

private static Object _EXPAND_ALL_BELOW_MENUITEM_ID

_EXPAND_ALL_MENUITEM_ID

private static Object _EXPAND_ALL_MENUITEM_ID

_EXPAND_MENUITEM_ID

private static Object _EXPAND_MENUITEM_ID

_FREEZE_MENUITEM_ID

private static Object _FREEZE_MENUITEM_ID

_FREEZE_TOOLBARITEM_ID

private static Object _FREEZE_TOOLBARITEM_ID

_GO_TO_TOP_MENUITEM_ID

private static Object _GO_TO_TOP_MENUITEM_ID

_GO_TO_TOP_TOOLBARITEM_ID

private static Object _GO_TO_TOP_TOOLBARITEM_ID

_GO_UP_TOOLBARITEM_ID

private static Object _GO_UP_TOOLBARITEM_ID

_hasColumns

private Object _hasColumns

_hasColumnSelection

private Object _hasColumnSelection

_hasMultiRowSelection

private Object _hasMultiRowSelection

_HIDDEN_COL_COUNT

private static Object _HIDDEN_COL_COUNT

_isInitialized

private Object _isInitialized

_isStandAloneTree

private Object _isStandAloneTree

_isTree

private Object _isTree

_MAX_SORT_COLUMNS

private static Object _MAX_SORT_COLUMNS

_POPUP_ID

private static Object _POPUP_ID

_QBE_MENUITEM_ID

private static Object _QBE_MENUITEM_ID

_QBE_TOOLBARITEM_ID

private static Object _QBE_TOOLBARITEM_ID

_REORDER_MENUITEM_ID

private static Object _REORDER_MENUITEM_ID

_RESIZECOLUMN_DIALOG_SELECTONE_ID

private static Object _RESIZECOLUMN_DIALOG_SELECTONE_ID

_RESIZECOLUMN_DIALOG_SPIN_ID

private static Object _RESIZECOLUMN_DIALOG_SPIN_ID

_RESIZECOLUMN_MENUITEM_ID

private static Object _RESIZECOLUMN_MENUITEM_ID

_ROWS_SELECTED_COUNT_ID

private static Object _ROWS_SELECTED_COUNT_ID

_ROWS_SELECTED_TEXT

private static Object _ROWS_SELECTED_TEXT

_ROWS_SELECTED_TEXT_ID

private static Object _ROWS_SELECTED_TEXT_ID

_SCROLL_TO_FIRST_MENUITEM_ID

private static Object _SCROLL_TO_FIRST_MENUITEM_ID

_SCROLL_TO_LAST_MENUITEM_ID

private static Object _SCROLL_TO_LAST_MENUITEM_ID

_SHOW_AS_TOP_MENUITEM_ID

private static Object _SHOW_AS_TOP_MENUITEM_ID

_SHOW_AS_TOP_TOOLBARITEM_ID

private static Object _SHOW_AS_TOP_TOOLBARITEM_ID

_SHOWCOLUMNS_DIALOG_SHUTTLE_ID

private static Object _SHOWCOLUMNS_DIALOG_SHUTTLE_ID

_SORT_ADVANCED_MENUITEM_ID

private static Object _SORT_ADVANCED_MENUITEM_ID

_SORT_ASCENDING_MENUITEM_ID

private static Object _SORT_ASCENDING_MENUITEM_ID

_SORT_DESCENDING_MENUITEM_ID

private static Object _SORT_DESCENDING_MENUITEM_ID

_SORT_DIALOG_CHOICE_ID

private static Object _SORT_DIALOG_CHOICE_ID

_SORT_DIALOG_RADIO_ID

private static Object _SORT_DIALOG_RADIO_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

panelCollection component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [viewMenu --> programmatic] - view menu id 2. [viewMenu_expand --> programmatic - view menu expand command menu item] 3. [viewMenu_expandAllBelow --> programmatic - view menu expand all below command menu item] 4. [viewMenu_collapseAllBelow --> programmatic - view menu collapse all below command menu item] 5. [viewMenu_expandAll --> programmatic - view menu expand all command menu item] 6. [viewMenu_collapseAll --> programmatic - view menu collapse all command menu item] 7. [viewMenu_showAsTop --> programmatic - view menu show as top command menu item] 8. [viewMenu_gotToTop --> programmatic - view menu go to top command menu item] 9. [viewMenu_scrollToFirst --> programmatic - view menu scroll to first command menu item] 10. [viewMenu_scrollToLast --> programmatic - view menu scroll to last command menu item]

_TOOLBAR_SPACER_ID

private static Object _TOOLBAR_SPACER_ID

_UNFREEZE_MENUITEM_ID

private static Object _UNFREEZE_MENUITEM_ID

_VIEW_MENU_ID

private static Object _VIEW_MENU_ID

_WRAP_MENUITEM_ID

private static Object _WRAP_MENUITEM_ID

_WRAP_TOOLBARITEM_ID

private static Object _WRAP_TOOLBARITEM_ID

AdfDhtmlPanelCollectionPeer

public AdfDhtmlPanelCollectionPeer()

Renders a Collection Decorator peer for composite table, treeTable, tree

_checkUpdateViewMenu

private Object _checkUpdateViewMenu(String action)

If we are showing and the visible column count was under 1, or if the previous count was at least 2 and we are hiding, then we need to PPR the parent of the reorder menu so that its visibility/rendered state is updated

Parameters:

action

-

'show' if showing a column, 'hide' if hiding a column, 'all' if showing all or 'multiple' if hiding or showing multiple columns

Return:

Object

collapseAllNodes

public Object collapseAllNodes()

Handler for the "Collpase All" standard Tree table menu item

Return:

Object

collapseAllNodesBelow

public Object collapseAllNodesBelow()

Handler for the "Collapse All Below" standard Tree table menu item

Return:

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)

detach

public Object detach()

Return:

Object

_detachContent

private Object _detachContent(Object component)

Parameters:

component

Return:

Object

expandAllNodes

public Object expandAllNodes()

Handler for the "Expand All" standard Tree table menu item

Return:

Object

expandAllNodesBelow

public Object expandAllNodesBelow()

Handler for the "Expand All Below" standard Tree table menu item

Return:

Object

expandNode

public Object expandNode()

Handler for the "Expand" standard Tree table menu item

Return:

Object

freezeColumns

public Object freezeColumns()

Handler for the "Freeze" action

Return:

Object

__getAutoHeightBottomFacetId

Object __getAutoHeightBottomFacetId()

Return:

Object

__getAutoHeightTopFacetId

Object __getAutoHeightTopFacetId()

Return:

Object

_getDOMContent

private Object _getDOMContent()

Return:

Object

_getFrozenColumn

private Object _getFrozenColumn(Object tableComponent)

Returns the frozen column or null if no column is frozen.

Parameters:

tableComponent

Return:

Object

_getRootColumn

private Object _getRootColumn(Object column,
                              Object tablePeer)

Parameters:

column
tablePeer

Return:

Object

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the dom element for a given subElementId for panelCollection component.

Parameters:

subElementId

-

the id of the child dom element or component

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

_getTheSelectedColumn

private Object _getTheSelectedColumn(Object table)

Parameters:

table

Return:

Object

goToTopNode

public Object goToTopNode()

Handler for the "Go To Top" standard Tree table menu item

Return:

Object

goUpNode

public Object goUpNode()

Handler for the "Go Up" standard Tree table toolbar item

Return:

Object

_handleAdvancedSortOK

private Object _handleAdvancedSortOK(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentAction

protected Object HandleComponentAction(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentDialog

protected Object HandleComponentDialog(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentPopupClosed

protected Object HandleComponentPopupClosed(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentPopupOpening

protected Object HandleComponentPopupOpening(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentShowColumns

protected Object HandleComponentShowColumns(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentValueChange

protected Object HandleComponentValueChange(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_handleResizeColumnOK

private Object _handleResizeColumnOK(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_handleShowColumnsOK

private Object _handleShowColumnsOK(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_hasFrozenColumn

private Object _hasFrozenColumn()

Returns true if child table has a frozen column.

Return:

Object

Init

protected Object Init(Object component,
                      Object usage)

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

Parameters:

component
usage

Return:

Object

Overrides:

AdfObject.Init()

_initialize

private Object _initialize()

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

isDetached

public Object isDetached()

Return:

Object

_isFreezeDisabled

private Object _isFreezeDisabled(Object selectedColumns)

Returns true if ability to freeze should be disabled, which if there is no column selection, there is only 1 visible column, or the selected column is the last column.

Parameters:

selectedColumns

Return:

Object

_isNodeStampColumnSelected

private Object _isNodeStampColumnSelected(Object tableComponent,
                                          Object selectedColumns)

Returns true if the columns selected includes the tree table nodestamp column.

Parameters:

tableComponent
selectedColumns

Return:

Object

PopupClosed

protected Object PopupClosed(Object component,
                             Object contentDom,
                             Object popupId)

Hook for notifying a peer that a popup of its was just closed.

Parameters:

component
contentDom
popupId

Return:

Object

Overrides:

AdfRichUIPeer.PopupClosed(AdfUIComponent, HTMLElement, String)

reorderColumns

public Object reorderColumns()

Return:

Object

resetState

public Object resetState()

Resets any local state that this peer may be holding. This method is useful because on a PPR of the table/treetable/tree, the old component is no longer valid

Return:

Object

resizeColumn

public Object resizeColumn()

Return:

Object

_restoreDOMContent

private Object _restoreDOMContent()

Return:

Object

scrollToFirst

public Object scrollToFirst()

Handler for the "Go To Top" standard Tree table menu item

Return:

Object

scrollToLast

public Object scrollToLast()

Handler for the "Go To Top" standard Tree table menu item

Return:

Object

_showAdvancedDialog

private Object _showAdvancedDialog(Object type)

Parameters:

type

Return:

Object

showAllColumns

public Object showAllColumns()

Handler for the showAllColumns standard menu item

Return:

Object

showColumn

public Object showColumn(Object componentEvent)

Handler for the showColumn(a particular column) standard menu item

Parameters:

componentEvent

Return:

Object

showColumnContextMenu

public Object showColumnContextMenu(Object domEvent,
                                    Object alignElement)

Shows the columns context menu if any for the composite table

Parameters:

domEvent
alignElement

Return:

Object

showMoreColumns

public Object showMoreColumns(Object tableId,
                              Object event)

Parameters:

tableId
event

Return:

Object

showNodeAsTop

public Object showNodeAsTop()

Handler for the "Show As Top" standard Tree table menu item

Return:

Object

showQBE

public Object showQBE()

Return:

Object

sortAdvanced

public Object sortAdvanced()

Return:

Object

sortAscending

public Object sortAscending()

Handler for the "Sort Ascending" standard menu item

Return:

Object

sortDescending

public Object sortDescending()

Handler for the "Sort Descending" standard menu item

Return:

Object

toggleFreeze

public Object toggleFreeze()

Handler for the "Freeze" toolbar button toggle

Return:

Object

toolboxRefreshNotify

public Object toolboxRefreshNotify()

This is called to refresh the status of the menu items and toolbars if the main toolbox is PPRed on the server

Return:

Object

_triggerSortEvent

private Object _triggerSortEvent(Object ascending)

Parameters:

ascending

Return:

Object

unfreezeColumns

public Object unfreezeColumns()

Handler for the "Unfreeze" action

Return:

Object

updateRowSelectionContext

public Object updateRowSelectionContext()

Updates menu/toolbar/statusbar items that are row selection dependent

Return:

Object

_updateRowSelectionCount

private Object _updateRowSelectionCount(Object isSelectAll,
                                        Object selectCount)

Parameters:

isSelectAll
selectCount

Return:

Object

_updateShowColMenuItems

private Object _updateShowColMenuItems(Object showAll,
                                       Object visibleColIds)

Parameters:

showAll
visibleColIds

Return:

Object

_updateSortMenuItems

private Object _updateSortMenuItems(Object tableComponent,
                                    Object selectedColumns,
                                    Object sortAscendingMenuItem,
                                    Object sortDescendingMenuItem)

Parameters:

tableComponent
selectedColumns
sortAscendingMenuItem
sortDescendingMenuItem

Return:

Object

updateStandardMenuToolbarItems

public Object updateStandardMenuToolbarItems()

Updates the standard menu items based on the column selection in the table

Return:

Object

updateStandardStatusbarItems

public Object updateStandardStatusbarItems()

Updates the standard statusbar items during the initial rendering of the table

Return:

Object

_updateTreeRowSelectionContext

private Object _updateTreeRowSelectionContext(Object treeComponent,
                                              Object isSelectAll,
                                              Object selectCount,
                                              Object firstRowKey)

Parameters:

treeComponent
isSelectAll
selectCount
firstRowKey

Return:

Object

wrapColumns

public Object wrapColumns()

Handler for the "Wrap" standard menu item/toolbar item

Return:

Object