ui.editor.Bubble Extends goog.events.EventTarget
Property bubble UI element.

Inheritance

Constructor

goog.ui.editor.Bubble(parentzIndex)

Parameters

parent : Element
The parent element for this bubble.
zIndex : number
The z index to draw the bubble at.

Instance Methods

Public Protected Private
addPanel(typetitletargetElementcontentFnopt_preferTopPosition) string
Adds a panel to the bubble.
Arguments:
type : string
The type of bubble panel this is. Should usually be the same as the tagName of the targetElement. This ensures multiple bubble panels don't appear for the same element.
title : string
The title of the panel.
targetElement : Element
The target element of the bubble.
contentFn : function(Element): void
Function that when called with a container element, will add relevant panel content to it.
opt_preferTopPosition : boolean=
Whether to prefer placing the bubble above the element instead of below it. Defaults to preferring below. If any panel prefers the top position, the top position is used.
Returns: string  The id of the panel.
code »
closeBubble_()
Closes the bubble.
code »
createBubbleDom(domcontainer) !Element
Creates and adds DOM for the bubble UI to the given container. This default implementation just returns the container itself.
Arguments:
dom : !goog.dom.DomHelper
DOM helper to use.
container : !Element
Element to add the new elements to.
Returns: !Element  The element where bubble content should be added.
code »
disposeInternal()
No description.
code »
getContainerElement() Element
No description.
Returns: Element  The element that contains the bubble.
code »
getContentElement() Element
No description.
Returns: Element  The element that where the bubble's contents go.
code »
getEventHandler() goog.events.EventHandler.<T>
No description.
Returns: goog.events.EventHandler.<T>  The event handler.
code »
getMarginBox() goog.math.Box
Returns the margin box.
Returns: goog.math.Box  No description.
code »
getViewportBox() goog.math.Box
Returns the viewport box to use when positioning the bubble.
Returns: goog.math.Box  No description.
code »
handlePopupHide()
Handles the popup's hide event by removing all panels and dispatching a HIDE event.
code »
handleWindowResize_()
Handles user resizing of window.
code »
hasPanelOfType(type) boolean
Returns whether there is already a panel of the given type.
Arguments:
type : string
Type of panel to check.
Returns: boolean  Whether there is already a panel of the given type.
code »
isVisible() boolean
Returns the visibility of the bubble.
Returns: boolean  True if visible false if not.
code »
openBubble_()
Opens the bubble.
code »
positionAtAnchor_(targetCornerbubbleCorneroverflow) number
A helper for reposition() - positions the bubble in regards to the position of the elements the bubble is attached to.
Arguments:
targetCorner : goog.positioning.Corner
The corner of the target element.
bubbleCorner : goog.positioning.Corner
The corner of the bubble.
overflow : number
Overflow handling mode bitmap, .
Returns: number  Status bitmap, .
code »
removePanel(id)
Removes the panel with the given id.
Arguments:
id : string
The id of the panel.
code »
reposition()
Positions and displays this bubble below its targetElement. Assumes that the bubbleContainer is already contained in the document object it applies to.
code »
setAutoHide(autoHide)
Sets whether the bubble dismisses itself when the user clicks outside of it.
Arguments:
autoHide : boolean
Whether to autohide on an external click.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

bubbleContainer_ :
Container element for the entire bubble. This may contain elements related to look and feel or styling of the bubble.
Code »
bubbleContents_ :
Container element for the bubble panels - this should be some inner element within (or equal to) bubbleContainer.
Code »
closeBox_ :
Element showing the close box.
Code »
constructor :
No description.
Code »
Dom helper for the document the bubble should be shown in.
Code »
eventHandler_ : goog.events.EventHandler
Event handler for this bubble.
Code »
A logger for goog.ui.editor.Bubble.
Code »
panels_ :
Maps panel ids to panels.
Code »
Popup that controls showing and hiding the bubble at the appropriate position.
Code »
viewPortSizeMonitor_ : goog.dom.ViewportSizeMonitor
Object that monitors the application window for size changes.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.ui.editor.Bubble.BUBBLE_CLASSNAME :
The css class name of the bubble container element.
Code »
goog.ui.editor.Bubble.MARGIN_BOX_ : goog.math.Box
Bubble's margin box to be passed to goog.positioning.
Code »
goog.ui.editor.Bubble.VERTICAL_CLEARANCE_ :
The vertical clearance in pixels between the bottom of the targetElement and the edge of the bubble.
Code »
goog.ui.editor.Bubble.superClass_ :
No description.
Code »

Package ui.editor

Package Reference