• index
• goog
• ui
• search: Go

The goog.ui.Popup Class

goog.ui.Popup
> goog.ui.PopupBase
> goog.events.EventTarget
> goog.Disposable

goog.ui.Popup(opt_element, opt_position)

The Popup class provides functionality for displaying an absolutely positioned element at a particular location in the window. It's designed to be used as the foundation for building controls like a menu or tooltip. The Popup class includes functionality for displaying a Popup near adjacent to an anchor element. This works cross browser and thus does not use IE's createPopup feature which supports extending outside the edge of the brower window.

opt_element {Element=}

A DOM element for the popup.

opt_position {goog.positioning.AbstractPosition=}

A positioning helper object.

The goog.ui.Popup.AbsolutePosition Class

Deprecated. Use {@link goog.positioning.AbsolutePosition} instead, this alias will be removed at the end of Q1 2009.

Encapsulates a popup position where the popup absolutely positioned by setting the left/top style elements directly to the specified values. The position is generally relative to the element's offsetParent. Normally, this is the document body, but can be another element if the popup element is scoped by an element with relative position. … more

The goog.ui.Popup.AnchoredPosition Class

Deprecated. Use {@link goog.positioning.AnchoredPosition} instead, this alias will be removed at the end of Q1 2009.

Encapsulates a popup position where the popup is anchored at a corner of an element. When using AnchoredPosition, it is recommended that the popup element specified in the Popup constructor or Popup.setElement be absolutely positioned. … more

The goog.ui.Popup.AnchoredViewPortPosition Class

Deprecated. Use {@link goog.positioning.AnchoredViewportPosition} instead, this alias will be removed at the end of Q1 2009.

Encapsulates a popup position where the popup is anchored at a corner of an element. The corners are swapped if dictated by the viewport. For instance if a popup is anchored with its top left corner to the bottom left corner of the anchor the popup is either displayed below the anchor (as specified) or above it if there's not enough room to display it below. When using AnchoredPosition, it is recommended that the popup element specified in the Popup constructor or Popup.setElement be absolutely positioned. … more

The goog.ui.Popup.ClientPosition Class

Deprecated. Use {@link goog.positioning.ClientPosition} instead, this alias will be removed at the end of Q1 2009.

Encapsulates a popup position where the popup is positioned relative to the window (client) coordinates. This calculates the correct position to use even if the element is relatively positioned to some other element. This is for trying to position an element at the spot of the mouse cursor in a MOUSEMOVE event. Just use the event.clientX and event.clientY as the parameters. … more

The goog.ui.Popup.ViewPortClientPosition Class

Deprecated. Use {@link goog.positioning.ViewPortClientPosition} instead, this alias will be removed at the end of Q1 2009.

Encapsulates a popup position where the popup is positioned relative to the window (client) coordinates, and made to stay within the viewport. … more

The goog.ui.Popup.ViewPortPosition Class

Deprecated. Use {@link goog.positioning.ViewPortPosition} instead, this alias will be removed at the end of Q1 2009.

Encapsulates a popup position where the popup is positioned according to coordinates relative to the element's view port (page). This calculates the correct position to use even if the element is relatively positioned to some other element. … more

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

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

.creationStack {string}

Inherited from goog.Disposable .

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

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}

Event object.

returns {boolean}

If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

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

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

.getAutoHide()

Inherited from goog.ui.PopupBase .

Returns whether the Popup dismisses itself when the user clicks outside of it.

returns {boolean}

Whether the Popup autohides on an external click.

.getAutoHideRegion()

Inherited from goog.ui.PopupBase .

Returns the region inside which the Popup dismisses itself when the user clicks, or null if it's the entire document.

returns {Element}

The DOM element for autohide, or null if it hasn't been set.

.getElement()

Inherited from goog.ui.PopupBase .

Returns the dom element that should be used for the popup.

returns {Element}

The popup element.

.getEnableCrossIframeDismissal()

Inherited from goog.ui.PopupBase .

returns {boolean}

Whether cross iframe dismissal is enabled.

.getHideOnEscape()

Inherited from goog.ui.PopupBase .

returns {boolean}

Whether the Popup autohides on the escape key.

.getLastHideTime()

Inherited from goog.ui.PopupBase .

Returns the time when the popup was last hidden.

returns {number}

time in ms since epoch when the popup was last hidden, or -1 if the popup was never hidden or is currently showing.

.getLastShowTime()

Inherited from goog.ui.PopupBase .

Returns the time when the popup was last shown.

returns {number}

time in ms since epoch when the popup was last shown, or -1 if the popup was never shown.

.getMargin()

Returns the margin to place around the popup.

returns {goog.math.Box?}

The margin.

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}

The parent EventTarget or null if there is no parent.

.getPinnedCorner()

Returns the corner of the popup to used in the positioning algorithm.

returns {goog.positioning.Corner}

The popup corner used for positioning.

.getPosition()

returns {goog.positioning.AbstractPosition}

The position helper object associated with the popup.

.getType()

Inherited from goog.ui.PopupBase .

returns {goog.ui.PopupBase.Type}

The type of popup this is.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.isOrWasRecentlyVisible()

Inherited from goog.ui.PopupBase .

Returns whether the popup is currently visible or was visible within about 150 ms ago. This is used by clients to handle a very specific, but common, popup scenario. The button that launches the popup should close the popup on mouse down if the popup is alrady open. The problem is that the popup closes itself during the capture phase of the mouse down and thus the button thinks it's hidden and this should show it again. This method provides a good heuristic for clients. Typically in their event handler they will have code that is: if (menu.isOrWasRecentlyVisible()) { menu.setVisible(false); } else { ... // code to position menu and initialize other state menu.setVisible(true); }

returns {boolean}

Whether the popup is currently visible or was visible within about 150 ms ago.

.isVisible()

Inherited from goog.ui.PopupBase .

Returns whether the popup is currently visible.

returns {boolean}

whether the popup is currently visible.

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

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.reposition()

Repositions the popup according to the current state.

.setAutoHide(autoHide)

Inherited from goog.ui.PopupBase .

Sets whether the Popup dismisses itself when the user clicks outside of it.

autoHide {boolean}

Whether to autohide on an external click.

.setAutoHideRegion(element)

Inherited from goog.ui.PopupBase .

Sets the region inside which the Popup dismisses itself when the user clicks.

element {Element}

The DOM element for autohide.

.setElement(elt)

Inherited from goog.ui.PopupBase .

Specifies the dom element that should be used for the popup.

elt {Element}

A DOM element for the popup.

.setEnableCrossIframeDismissal(enable)

Inherited from goog.ui.PopupBase .

Sets whether clicks in other iframes should dismiss this popup. In some cases it should be disabled, because it can cause spurious

enable {boolean}

Whether to enable cross iframe dismissal.

.setHideOnEscape(hideOnEscape)

Inherited from goog.ui.PopupBase .

Sets whether the Popup dismisses itself on the escape key.

hideOnEscape {boolean}

Whether to autohide on the escape key.

.setMargin(arg1, opt_arg2, opt_arg3, opt_arg4)

Sets the margin to place around the popup.

arg1 {goog.math.Box|number|null}

Top value or Box.

opt_arg2 {number=}

Right value.

opt_arg3 {number=}

Bottom value.

opt_arg4 {number=}

Left value.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}

Parent EventTarget (null if none).

.setPinnedCorner(corner)

Sets the corner of the popup to used in the positioning algorithm.

corner {goog.positioning.Corner}

The popup corner used for positioning.

.setPosition(position)

Sets the position helper object associated with the popup.

position {goog.positioning.AbstractPosition}

A position helper object.

.setShouldHideAsync(b)

Inherited from goog.ui.PopupBase .

Sets whether the popup should hide itself asynchronously using a timeout instead of synchronously.

b {boolean}

Whether to hide async.

.setTransition(opt_showTransition, opt_hideTransition)

Inherited from goog.ui.PopupBase .

Sets transition animation on showing and hiding the popup.

opt_showTransition {goog.fx.Transition=}

Transition to play on showing the popup.

opt_hideTransition {goog.fx.Transition=}

Transition to play on hiding the popup.

.setType(type)

Inherited from goog.ui.PopupBase .

Specifies the type of popup to use.

type {goog.ui.PopupBase.Type}

Type of popup.

.setVisible(visible)

Inherited from goog.ui.PopupBase .

Sets whether the popup should be visible. After this method returns, isVisible() will always return the new state, even if there is a transition.

visible {boolean}

Desired visibility state.

.shouldHideAsync()

Inherited from goog.ui.PopupBase .

Returns whether the popup should hide itself asynchronously using a timeout instead of synchronously.

returns {boolean}

Whether to hide async.

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