The goog.ui.IframeMask Class

goog.ui.IframeMask
> goog.Disposable

goog.ui.IframeMask(opt_domHelper, opt_iframePool)

Controller for an iframe mask. The mask is only valid in the current document, or else the document of the given DOM helper.

opt_domHelper {goog.dom.DomHelper=}
The DOM helper for the relevant document.
opt_iframePool {goog.structs.Pool=}
An optional source of iframes. Iframes will be grabbed from the pool when they're needed and returned to the pool (but still attached to the DOM) when they're done.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}
The callback function.
opt_scope {Object=}
An optional scope to call the callback in.

.applyMask()

Applies the iframe mask to the screen.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}
Nothing.

.hideMask()

Removes the mask from the screen.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}
Whether the object has been disposed of.

.listenOnTarget(target, showEvent, hideEvent, opt_snapElement)

Listens on the specified target, hiding and showing the iframe mask when the given event types are dispatched.

target {goog.events.EventTarget}
The event target to listen on.
showEvent {string}
When this event fires, the mask will be applied.
hideEvent {string}
When this event fires, the mask will be hidden.
opt_snapElement {Element=}
When the mask is applied, it will automatically snap to this element. If no element is specified, it will use the default snap element.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}
that will be disposed when this object is disposed.

.removeHandlers()

Removes all handlers attached by listenOnTarget.

.setOpacity(opacity)

Sets the opacity of the mask. Will take effect the next time the mask is applied.

opacity {number}
A value between 0 and 1, with 1 being totally opaque.

.setSnapElement(snapElement)

Sets the element to use as the bounds of the mask. Takes effect immediately.

snapElement {Element}
The snap element, which the iframe will be "snapped" around.

.setZIndex(zIndex)

Sets the z-index of the mask. Will take effect the next time the mask is applied.

zIndex {number}
A z-index value.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.