goog.ui.IframeMask

Provided By	`goog.ui.IframeMask`
Extends	`goog.Disposable`
All Implemented Interfaces	`goog.disposable.IDisposable`

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

new IframeMask( `opt_domHelper`, `opt_iframePool` )

Parameters

`opt_domHelper`	`(goog.dom.DomHelper\|null)=`
	The DOM helper for the relevant document.
`opt_iframePool`	`(goog.structs.Pool\|null)=`
	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.

VIEW SOURCE

Instance Methods

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Defined by

goog.Disposable

Parameters

`callback`	`function(): ?`
	The callback function.
`opt_scope`	`(T\|null)=`
	An optional scope to call the callback in.

VIEW SOURCE

Applies the iframe mask to the screen.

VIEW SOURCE

Disposes of the object and its resources.

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

Nothing.

VIEW SOURCE

Removes the iframe from the DOM.

Overrides	`goog.Disposable`
Parameters	None.

VIEW SOURCE

Deprecated	Use `#isDisposed` instead.

Defined by

goog.Disposable

Parameters

None.

Returns

boolean

Whether the object has been disposed of.

VIEW SOURCE

Removes the mask from the screen.

VIEW SOURCE

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

boolean

Whether the object has been disposed of.

VIEW SOURCE

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

Parameters

`target`	`(goog.events.EventTarget\|null)`
	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\|null)=`
	When the mask is applied, it will automatically snap to this element. If no element is specified, it will use the default snap element.

VIEW SOURCE

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

Defined by

goog.Disposable

Parameters

`disposable`	`(goog.disposable.IDisposable\|null)`
	that will be disposed when this object is disposed.

VIEW SOURCE

Removes all handlers attached by listenOnTarget.

VIEW SOURCE

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

Parameters

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

VIEW SOURCE

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

Parameters

`snapElement`	`(Element\|null)`
	The snap element, which the iframe will be "snapped" around.

VIEW SOURCE

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

Parameters

`zIndex`	`number`
	A z-index value.

VIEW SOURCE

Instance Properties

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

VIEW SOURCE

goog.ui.IframeMask

new IframeMask( `opt_domHelper`, `opt_iframePool` )

Instance Methods

`this.`addOnDisposeCallback`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`applyMask() `→` `void`

`this.`dispose() `→` `?`

`this.`disposeInternal() `→` `void`

`this.`getDisposed() `→` `boolean`

`this.`hideMask() `→` `void`

`this.`isDisposed() `→` `boolean`

`this.`listenOnTarget( `target`, `showEvent`, `hideEvent`, `opt_snapElement` ) `→` `void`

`this.`registerDisposable( `disposable` ) `→` `void`

`this.`removeHandlers() `→` `void`

`this.`setOpacity( `opacity` ) `→` `void`

`this.`setSnapElement( `snapElement` ) `→` `void`

`this.`setZIndex( `zIndex` ) `→` `void`

Instance Properties

`this.`creationStack `→` `(string|undefined)`

goog.ui.IframeMask

new IframeMask( opt_domHelper, opt_iframePool )

Instance Methods

this.addOnDisposeCallback<T>( callback, opt_scope ) → void

this.applyMask() → void

this.dispose() → ?

this.disposeInternal() → void

this.getDisposed() → boolean

this.hideMask() → void

this.isDisposed() → boolean

this.listenOnTarget( target, showEvent, hideEvent, opt_snapElement ) → void

this.registerDisposable( disposable ) → void

this.removeHandlers() → void

this.setOpacity( opacity ) → void

this.setSnapElement( snapElement ) → void

this.setZIndex( zIndex ) → void

Instance Properties

this.creationStack → (string|undefined)

new IframeMask( `opt_domHelper`, `opt_iframePool` )

`this.`addOnDisposeCallback`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`applyMask() `→` `void`

`this.`dispose() `→` `?`

`this.`disposeInternal() `→` `void`

`this.`getDisposed() `→` `boolean`

`this.`hideMask() `→` `void`

`this.`isDisposed() `→` `boolean`

`this.`listenOnTarget( `target`, `showEvent`, `hideEvent`, `opt_snapElement` ) `→` `void`

`this.`registerDisposable( `disposable` ) `→` `void`

`this.`removeHandlers() `→` `void`

`this.`setOpacity( `opacity` ) `→` `void`

`this.`setSnapElement( `snapElement` ) `→` `void`

`this.`setZIndex( `zIndex` ) `→` `void`

`this.`creationStack `→` `(string|undefined)`