JavaScript API Reference for Oracle ADF Faces

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

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

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.AdfDhtmlInlineFramePeer

public class AdfDhtmlInlineFramePeer
extends AdfRichUIPeer

Field Summary

protected Object	GetSubIdDomElement Returns the dom element for a given subElementId for inlineFrame component.
private static Object	_iframeIds
private static Object	_LOAD_EVENT_TYPE
private static Object	_SUB_ID_MAP inlineFrame component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.

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

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, CreateSubId, DISABLED_STYLECLASS, DRAG_READY_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

AdfDhtmlInlineFramePeer()

Method Summary

protected void	BindToComponent(AdfUIComponent component, HTMLElement domElement) If the sizing is "preferred", registers a resize listener.
protected void	ComponentRemoved(AdfUIComponent component) Override to unregister this iframe from the polling lsit.
protected void	ComponentSourceChanged(AdfRichInlineFrame component, Object domElement, String newValue, Object oldValue) Optimized setter for the "source" attribute.
HTMLIFrameElement	__getIframe(HTMLElement domElement)
static Object	__iframeLoadHandler(Object evt) This is an "onload" callback registered on the iframe by the server-side renderer.
protected void	InitDomElement(AdfUIComponent component, HTMLElement rootElement) Initialize the associated domElement when the peer is created.
protected static Object	InitSubclass() Override to initialize the array used for tracking iframe's that need their preferred size calculated
private static boolean	_isIframeSizingAllowed(HTMLElement iframeDom) Tests if we can can size the iFrame source.
private static void	_minSizeResizeListener() Timer callback for performing resizing on the registered iframes.
private static void	_registerIFrameForSizing(HTMLElement iframeDom) Called when a new iframe needs to be registered with the resizing service.
private static Object	_removeLoadingStatus(Object iframeDom, Object clientId)
private static frame	_replaceIframe(Object iframeElement) Pass in the initial iframe created for the component and creates a new iframe with the target source applied.
private static Boolean	_resizeIframeToPreferred(HTMLElement iframeDom) Resizes the iframe to its preferred size, returning true if any resizing actually ocurred.
protected void	ScrollIntoView(Object component, Object focus, String subTargetId) Overrriden to provide Inline Frame specific implementation.

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, 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, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

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

getDefaultDragRecognizer, getParentPeer, Init, initiateDrag, isVisible, needsResizeNotify

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

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

Field Detail

GetSubIdDomElement

protected Object GetSubIdDomElement

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

_iframeIds

private static Object _iframeIds

_LOAD_EVENT_TYPE

private static Object _LOAD_EVENT_TYPE

_SUB_ID_MAP

private static Object _SUB_ID_MAP

inlineFrame component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [targetFrame --> mapped programmatically] - internal iframe element

Constructor Detail

AdfDhtmlInlineFramePeer

public AdfDhtmlInlineFramePeer()

Method Detail

BindToComponent

protected void BindToComponent(AdfUIComponent component,
HTMLElement domElement)

If the sizing is "preferred", registers a resize listener.

Parameters:

component	-	target component to bind
domElement	-	dom element component is bound

Return:

void - null

Overrides:

AdfRichUIPeer.BindToComponent(Object, Object)

ComponentRemoved

protected void ComponentRemoved(AdfUIComponent component)

Override to unregister this iframe from the polling lsit.

Parameters:

component

-

Component being disassociated from the peer

Return:

void - null

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

ComponentSourceChanged

protected void ComponentSourceChanged(AdfRichInlineFrame component,
Object domElement,
String newValue,
Object oldValue)

Optimized setter for the "source" attribute.

Parameters:

component	-	inline frame
domElement
newValue	-	new source property value
oldValue

Return:

void - null

__getIframe

HTMLIFrameElement __getIframe(HTMLElement domElement)

Parameters:

domElement

-

optional element if called before the component has fully initialized Default value = null

Return:

HTMLIFrameElement - returns the iframe that contains the source document. The location of the iframe under the inlineFrame component varies depending on the agent. This method will return the iframe regardless of the agent.

__iframeLoadHandler

static Object __iframeLoadHandler(Object evt)

This is an "onload" callback registered on the iframe by the server-side renderer. This is necessary because InitDomElement will always come after the iframe has finished loading.

Parameters:

evt

Return:

Object

InitDomElement

protected void InitDomElement(AdfUIComponent component,
HTMLElement rootElement)

Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called. Lazily sets the "scr" attribute of the iframe to minimize the number of verbose GET request when the iframe element is re-parented.

Parameters:

component	-	Component that this peer will be associated with
rootElement	-	Root DOM element of this peer

Return:

void - null

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Override to initialize the array used for tracking iframe's that need their preferred size calculated

Return:

Object

_isIframeSizingAllowed

private static boolean _isIframeSizingAllowed(HTMLElement iframeDom)

Tests if we can can size the iFrame source. If we cannot, a warning is logged and the method returns false. This method should be checked before setting sizing to preferred, to see if user has an invalid setup - source set outside the server's domain and sizing set to preferred.

Parameters:

iframeDom

-

the iframe dom source

Return:

boolean - true if access is allowed

_minSizeResizeListener

private static void _minSizeResizeListener()

Timer callback for performing resizing on the registered iframes.

Return:

void - null

_registerIFrameForSizing

private static void _registerIFrameForSizing(HTMLElement iframeDom)

Called when a new iframe needs to be registered with the resizing service.

Parameters:

iframeDom

Return:

void - null

_removeLoadingStatus

private static Object _removeLoadingStatus(Object iframeDom,
Object clientId)

Parameters:

iframeDom
clientId

Return:

Object

_replaceIframe

private static frame _replaceIframe(Object iframeElement)

Pass in the initial iframe created for the component and creates a new iframe with the target source applied. The iframe is initally rendered with a blank.html src attribute. This is to avoid GET requests to the actual page during a PPR when the iframe is created. This sledgehammer approach avoids browser history for iframe navigation so that the browser back button doesn't record the navigation.

Parameters:

iframeElement

Return:

frame - new iframe created with the target source

_resizeIframeToPreferred

private static Boolean _resizeIframeToPreferred(HTMLElement iframeDom)

Resizes the iframe to its preferred size, returning true if any resizing actually ocurred.

Parameters:

iframeDom

Return:

Boolean - true if any resizing occurred.

ScrollIntoView

protected void ScrollIntoView(Object component,
Object focus,
String subTargetId)

Overrriden to provide Inline Frame specific implementation.

Parameters:

component
focus
subTargetId	-	optional component dependent DOM sub-id that needs to be scrolled/focused into view Default value = null

Return:

void - null

Overrides:

AdfRichUIPeer.scrollIntoView(Object, Object, String)

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