JavaScript API Reference for Oracle ADF Faces

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

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

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

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.AdfDhtmlPanelBoxPeer
                           |
                           +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlRegionPeer

public class AdfDhtmlRegionPeer
extends AdfDhtmlPanelBoxPeer

Peer for a Region.

Field Summary

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

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_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

AdfDhtmlRegionPeer() Peer for a Region.

Method Summary

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.
protected HTMLElement	DomReplaceNotify(HTMLElement replacedDomNode) Handles child dom replacement after PPR activity.
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.
protected Object	InitDomElement(Object component, Object domElement) Register DOM event handlers.
private Object	_isRegionStretched(HTMLElement regionElement) Retreives whether the region itself is stretched.
private Object	_stretchOnlyChild(HTMLElement regionElement, HTMLElement onlyChild) Apply styles that allow stretching of the height of the given child to work properly.
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

Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelBoxPeer

animateUndisclosure, getDefaultDragRecognizer, GetSubIdDomElement, HandleComponentClick, HandleComponentKeyUp, InitSubclass

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, convertLocatorToClientId, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, 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, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, Init, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

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

getParentPeer, initiateDrag, isVisible, needsResizeNotify

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

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

Field Detail

Constructor Detail

AdfDhtmlRegionPeer

public AdfDhtmlRegionPeer()

Peer for a Region.

Method Detail

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

Overrides:

AdfRichUIPeer.ConvertClientIdToLocator(Object, Object, Object, 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

Overrides:

AdfRichUIPeer.domReplaceNotify(AdfUIComponent, 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

InitDomElement

protected Object InitDomElement(Object component,
Object domElement)

Register DOM event handlers.

Parameters:

component
domElement

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, 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

_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

Overrides:

AdfRichUIPeer.TruncateClientId(Object, Object, Object, Object)

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