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

private static Object

_iframeIds

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

AdfDhtmlInlineFramePeer()

Method Summary

protected Object	ComponentRemoved(AdfUIComponent component) Override to unregister this iframe from the polling lsit
protected Object	ComponentSourceChanged(Object component, Object domElement, Object newValue, Object oldValue) Optimized setter for the "source" attribute
IFrame	__getIframe()
static Object	__iframeLoadHandler(Event event) 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
protected Object	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 Object	_isIframeSizingAllowed(Object iframeDom) Tests if we can can size the iFrame source.
private static Object	_minSizeResizeListener() Timer callback for performing resizing on the registered iframes
private static Object	_registerIFrameForSizing(HTMLElement iframeDom) Called when a new iframe needs to be registered with the resizing service
private static Boolean	_resizeIframeToPreferred(HTMLElement iframeDom) Resizes the iframe to its preferred size, returning true if any resizing actually ocurred.
protected Object	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, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, 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, needsChildVisibilityChanges, 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, 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

_iframeIds

private static Object _iframeIds

Constructor Detail

AdfDhtmlInlineFramePeer

public AdfDhtmlInlineFramePeer()

Method Detail

ComponentRemoved

protected Object ComponentRemoved(AdfUIComponent component)

Override to unregister this iframe from the polling lsit

Parameters:

component

-

Component being disassociated from the peer

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

ComponentSourceChanged

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

Optimized setter for the "source" attribute

Parameters:

component
domElement
newValue
oldValue

Return:

Object

__getIframe

IFrame __getIframe()

Return:

IFrame - 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(Event event)

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:

event

Return:

Object

InitDomElement

protected Object 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.

Parameters:

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

Return:

Object

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 Object _isIframeSizingAllowed(Object 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:

Object - boolean true if access is allowed

_minSizeResizeListener

private static Object _minSizeResizeListener()

Timer callback for performing resizing on the registered iframes

Return:

Object

_registerIFrameForSizing

private static Object _registerIFrameForSizing(HTMLElement iframeDom)

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

Parameters:

iframeDom

Return:

Object

_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 Object 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:

Object

Overrides:

AdfRichUIPeer.scrollIntoView(Object, Object, String)

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