JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich.subids
Class AdfDhtmlRegionPeer

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlRegionPeer

public class AdfDhtmlRegionPeer
extends Object

_INNER_MAXIMIZE_PEER

private static Object _INNER_MAXIMIZE_PEER

_setUncommittedDataWarning

private Object _setUncommittedDataWarning

_SUB_ID_MAP

private static Object _SUB_ID_MAP

region component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [disclosure_icon --> _afrDscl] - the disclosure icon 2. [content --> content] - region content 3. [title] - the title (mapped programmatically) Note that "title" does not have a corresponding ID to map to. Instead it is determined programmatically in AdfDhtmlRegionPeer.GetSubIdDomElement().

AdfDhtmlRegionPeer

public AdfDhtmlRegionPeer()

region component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [disclosure_icon --> _afrDscl] - the disclosure icon 2. [content --> content] - region content 3. [title] - the title (mapped programmatically) Note that "title" does not have a corresponding ID to map to. Instead it is determined programmatically in AdfDhtmlRegionPeer.GetSubIdDomElement().

componentRemoved

public Object componentRemoved(Object component)

Parameters:

component

Return:

Object

ConvertClientIdToLocator

protected Object ConvertClientIdToLocator(Object component,
                                          Object childComponent,
                                          Object descComponentClientId,
                                          Object replaceArray)

Function to replace client id fragments when converting a clientId to an absolute locator. Remove the first id fragment, which is the extra naming container level after the region id while creating absolute locator.

The peer is not bound when this method is called

Parameters:

component	-	The region component for this peer
childComponent
descComponentClientId	-	The clientId of the component that the absolute scoped id is being generated for
replaceArray	-	Array of key-value array in format [<index>, <item>] to either skip or skip and fix the parent id fragment with the item value

Return:

Object

CreateDisclosurePeer

protected Object CreateDisclosurePeer(Object component)

Hook point for subclasses (like the RegionPeer) to override the inner disclosure peer creation

Parameters:

component

Return:

Object

CreateMaximizePeer

protected Object CreateMaximizePeer(Object component)

Hook point for subclasses (like the RegionPeer) to override the inner maximize peer creation

Parameters:

component

Return:

Object

DomReplaceNotify

protected HTMLElement DomReplaceNotify(HTMLElement replacedDomNode)

Handles child dom replacement after PPR activity.

Parameters:

replacedDomNode

-

the new DOM element

Return:

HTMLElement - the element at which the resize notify traversal will start

getAnimationDurationKey

public Object getAnimationDurationKey()

Return:

Object

GetContentDomElement

protected Object GetContentDomElement(Object rootElement)

Returns the DOM element used for the Region content. The optional rootElement allows this to be called from InitDomElement.

Parameters:

rootElement

Return:

Object

_getOnlyChildElement

private static HTMLElement _getOnlyChildElement(HTMLElement parentElement)

Returns the only child element underneath the specified parent, or null if the parent has zero or more than one child element. This function differs from AdfDomUtils.getOnlyChildElement in that it will dig inside of wrapper divs that the region renderer may introduce. The parentElement may have children that have their own wrappers. We need to look inside of these wrappers and treat those children as if they were direct children of the parentElement.

Parameters:

parentElement

-

the node whose children we want to retrieve the sole child from

Return:

HTMLElement - the only child element or null if 0 or more than 1 displayed child is found

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementId)

Returns the DOM element identified by the passed in subId.

Parameters:

subElementId

Return:

Object - the DOM element

InitDirtyTracking

protected Object InitDirtyTracking()

Return:

Object

InitDomElement

protected Object InitDomElement(Object component,
                                Object domElement)

Register DOM event handlers.

Parameters:

component
domElement

Return:

Object

_isRegionStretched

private Object _isRegionStretched(HTMLElement regionElement)

Retreives whether the region itself is stretched.

Parameters:

regionElement

-

the root DOM element of this region

Return:

Object

_setUncommittedDataWarning

private Object _setUncommittedDataWarning(Object component)

Parameters:

component

Return:

Object

_stretchOnlyChild

private Object _stretchOnlyChild(HTMLElement regionElement,
                                 HTMLElement onlyChild)

Apply styles that allow stretching of the height of the given child to work properly.

Parameters:

regionElement	-	the root DOM element of this region
onlyChild	-	the child DOM element of this region to stretch

Return:

Object

TruncateClientId

protected Object TruncateClientId(Object component,
                                  Object descendantComponent,
                                  Object childClientId,
                                  Object skipArray)

Remove the first id fragment after the region id when creating absolute scoped ids

Parameters:

component
descendantComponent
childClientId
skipArray

Return:

Object