ManageIframe:Manual:Frame Panel (Legacy)
This version of our Learning Center is unmaintained.
This article may be out-of-date or contain incorrect information.
Please visit the new Sencha Learning Center for up-to-date material.
From Sencha - Learn
ux.ManagedIframePanel
This component extends the existing Ext.Panel with the logic necessary to manage a single ManagedIFrame instance embedded in the Panels' body element.
ManagedIframePanel Config Options
ManagedIframePanel:autoLoad
ManagedIframePanel:defaultSrc
ManagedIframePanel:disableMessaging
ManagedIframePanel:eventsFollowFrameLinks
ManagedIframePanel:fitToParent
ManagedIframePanel:frameConfig
ManagedIframePanel:frameStyle
ManagedIframePanel:html
ManagedIframePanel:loadMask
ManagedIframePanel:listeners
ManagedIframePanel:showLoadIndicator
ManagedIframePanel:unsupportedText
ManagedIframePanel Methods
ManagedIframePanel:getUpdater
As in a standard [2.0] Ext.Panel, use the getUpdater method to retrieve the UpdateManager instance for the ManagedIFrame embedded in the Panels' body for updating. Overwrites the current embedded document structure with a new one using UpdateManager. (Ext.UpdateManager compatible)
Syntax:
getUpdater().update( content [, loadScripts] [, callbackFn ] )
Parameter Description:
- content - (string or Ext.DomHelper config object) representing the text/markup to be written directly to the frames document interface. The frames existing document is destroyed and replaced by content.
- loadScripts - (boolean, optional) if false, all <script> tag references are removed from the content prior to the update.
- callbackFn - (function, optional) The callback function to execute after the content has been written and the document reports a loaded state.
Possible events raised:
- domready
- documentloaded
- exception
Example:
mifpanel.getUpdater().update("<div> Test content </div>", false, updCallBackFn);
Alternately, you could achieve the same by referencing the embedded frame directly:
mifpanel.getFrame().update( "<div> Test content </div>", false, updCallBackFn );
ManagedIframePanel:getFrame
Returns the ManagedIFrame Component embedded in the Panels body element.
Syntax:
getFrame()
ManagedIframePanel:getFrameDocument
Returns the document object of the panels embedded frame, or null of not available.
Syntax:
getFrameDocument()
ManagedIframePanel:getFrameWindow
Returns the Window object of the embedded frame, or null of not available.
Syntax:
getFrameWindow()
ManagedIframePanel:sendMessage
Sends a message to the Window context of the components' managed IFRAME. (for implementation details, see Cross-frame messaging with ManagedIFrame)
Syntax:
sendMessage( message [, tag] [, origin ] )
Parameter Description:
- message - (mixed) the message content to be sent.
- tag - (string, optional) additional tag reference for domain identification.
- origin - (string, optional) defaults the senders document.domain.
Possible events raised:
- exception
Example:
ManagedIframePanel:showDragMask
[deprecated 1.1, see ManagedIframe.Manager.showShims/hideShims] This method activates a custom masking IMG used to aid in drag operations which might "transit" the embedded frame. Note: calling the showShims method of ManagedIframe.Manager masks ALL ManagedIframes in use on the page.
Syntax:
Ext.ux.ManagedIframe.Manager.showShims() Ext.ux.ManagedIframe.Manager.hideShims()
Parameter Description: None
ManagedIframePanel:hideDragMask
[deprecated 1.1, see ManagedIframe.Manager.showShims/hideShims above] This method de-activates ALL frame dragMasks enabled by the :showDragMask method.
Syntax:
hideDragMask()
Parameter Description: None
ManagedIframePanel:toggleShim
Toggles visibility of the transparent shimming agent used to mask the frame during dragging or other operations.
Syntax:
toggleShim()
Parameter Description: None