Toolbar (Closure Library API Documentation

Index at which the new child is to be added.

opt_render :

(boolean | undefined)

Whether the new child should be rendered immediately after being added (defaults to false).

code »

canDecorate(element) ⇒

Returns true if the given element can be decorated by this container. Overrides goog.ui.Component#canDecorate.

Arguments:

element :

(Element | null)

Element to decorate.

Returns:

True iff the element can be decorated.

code »

canHighlightItem(item) ⇒

Returns whether the given item can be highlighted.

Arguments:

item :

(goog.ui.Control | null)

The item to check.

Returns:

Whether the item can be highlighted.

code »

createDom()

Creates the container's DOM. Overrides goog.ui.Component#createDom.

code »

decorateInternal(element)

Decorates the given element with this container. Overrides goog.ui.Component#decorateInternal. Considered protected.

Arguments:

element :

(Element | null)

Element to decorate.

code »

disposeInternal()

No description.

code »

enableFocusHandling_(enable)

Sets up listening for events applicable to focusable containers.

Arguments:

enable :

Whether to enable or disable focus handling.

code »

enterDocument()

Configures the container after its DOM has been rendered, and sets up event handling. Overrides goog.ui.Component#enterDocument.

code »

exitDocument()

Cleans up the container before its DOM is removed from the document, and removes event handlers. Overrides goog.ui.Component#exitDocument.

code »

getChild(id) ⇒

(goog.ui.Control | null)

Overrides goog.ui.Container#getChild to make it clear that it only returns goog.ui.Controls.

Arguments:

id :

Child component ID.

Returns:

(goog.ui.Control | null)

The child with the given ID; null if none.

code »

getChildAt(index) ⇒

(goog.ui.Control | null)

Overrides goog.ui.Container#getChildAt to make it clear that it only returns goog.ui.Controls.

Arguments:

index :

0-based index.

Returns:

(goog.ui.Control | null)

The child with the given ID; null if none.

code »

getContentElement() ⇒

(Element | null)

Returns the DOM element into which child components are to be rendered, or null if the container itself hasn't been rendered yet. Overrides goog.ui.Component#getContentElement by delegating to the renderer.

Returns:

(Element | null)

Element to contain child elements (null if none).

code »

getHighlighted() ⇒

(goog.ui.Control | null)

Returns the currently highlighted item (if any).

Returns:

(goog.ui.Control | null)

Highlighted item (null if none).

code »

getHighlightedIndex() ⇒

Returns the index of the currently highlighted item (-1 if none).

Returns:

Index of the currently highlighted item.

code »

getKeyEventTarget() ⇒

(Element | null)

Returns the DOM element on which the container is listening for keyboard events (null if none).

Returns:

(Element | null)

Element on which the container is listening for key events.

code »

getKeyHandler() ⇒

(goog.events.KeyHandler | null)

Returns the keyboard event handler for this container, lazily created the first time this method is called. The keyboard event handler listens for keyboard events on the container's key event target, as determined by its renderer.

Returns:

(goog.events.KeyHandler | null)

Keyboard event handler for this container.

code »

getOpenItem() ⇒

(goog.ui.Control | null)

Returns the currently open (expanded) control in the container (null if none).

Returns:

(goog.ui.Control | null)

The currently open control.

code »

getOrientation() ⇒

(goog.ui.Container.Orientation.<string> | null)

Returns the container's orientation.

Returns:

(goog.ui.Container.Orientation.<string> | null)

Container orientation.

code »

getOwnerControl(node) ⇒

(goog.ui.Control | null)

Returns the child control that owns the given DOM node, or null if no such control is found.

Arguments:

node :

(Node | null)

DOM node whose owner is to be returned.

Returns:

(goog.ui.Control | null)

Control hosted in the container to which the node belongs (if found).

code »

getRenderer() ⇒

(goog.ui.ContainerRenderer | null)

Returns the renderer used by this container to render itself or to decorate an existing element.

Returns:

(goog.ui.ContainerRenderer | null)

Renderer used by the container.

code »

handleBlur(e)

Handles blur events raised when the container's key event target loses keyboard focus. The default implementation clears the highlight index.

Arguments:

e :

(goog.events.BrowserEvent | null)

Blur event to handle.

code »

handleChildMouseEvents(e)

Handles mouse events originating from nodes belonging to the controls hosted in the container. Locates the child control based on the DOM node that dispatched the event, and forwards the event to the control for handling.

Arguments:

e :

(goog.events.BrowserEvent | null)

Mouse event to handle.

code »

handleCloseItem(e)

Handles CLOSE events dispatched by items in the container when they are closed.

Arguments:

e :

(goog.events.Event | null)

Close event to handle.

code »

handleDocumentMouseUp(e)

Handles mouseup events over the document. The default implementation clears the "mouse button pressed" flag.

Arguments:

e :

(goog.events.BrowserEvent | null)

Mouseup event to handle.

code »

handleEnterItem(e) ⇒

Handles ENTER events raised by child controls when they are navigated to.

Arguments:

e :

(goog.events.Event | null)

ENTER event to handle.

Returns:

Whether to prevent handleMouseOver from handling the event.

code »

handleFocus(e)

Handles focus events raised when the container's key event target receives keyboard focus.

Arguments:

e :

(goog.events.BrowserEvent | null)

Focus event to handle.

code »

handleHighlightItem(e)

Handles HIGHLIGHT events dispatched by items in the container when they are highlighted.

Arguments:

e :

(goog.events.Event | null)

Highlight event to handle.

code »

handleKeyEvent(e) ⇒

Attempts to handle a keyboard event, if the control is enabled, by calling handleKeyEventInternal. Considered protected; should only be used within this package and by subclasses.

Arguments:

e :

(goog.events.KeyEvent | null)

Key event to handle.

Returns:

Whether the key event was handled.

code »

handleKeyEventInternal(e) ⇒

Attempts to handle a keyboard event; returns true if the event was handled, false otherwise. If the container is enabled, and a child is highlighted, calls the child control's handleKeyEvent method to give the control a chance to handle the event first.

Arguments:

e :

(goog.events.KeyEvent | null)

Key event to handle.

Returns:

Whether the event was handled by the container (or one of its children).

code »

handleMouseDown(e)

Handles mousedown events over the container. The default implementation sets the "mouse button pressed" flag and, if the container is focusable, grabs keyboard focus.

Arguments:

e :

(goog.events.BrowserEvent | null)

Mousedown event to handle.

code »

handleOpenItem(e)

Handles OPEN events dispatched by items in the container when they are opened.

Arguments:

e :

(goog.events.Event | null)

Open event to handle.

code »

handleUnHighlightItem(e)

Handles UNHIGHLIGHT events dispatched by items in the container when they are unhighlighted.

Arguments:

e :

(goog.events.Event | null)

Unhighlight event to handle.

code »

highlightFirst()

Highlights the first highlightable item in the container

code »

highlightHelper(fn, startIndex) ⇒

Helper function that manages the details of moving the highlight among child controls in response to keyboard events.

Arguments:

fn :

function (number, number): number

Function that accepts the current and maximum indices, and returns the next index to check.

startIndex :

Start index.

Returns:

Whether the highlight has changed.

code »

highlightLast()

Highlights the last highlightable item in the container.

code »

highlightNext()

Highlights the next highlightable item (or the first if nothing is currently highlighted).

code »

highlightPrevious()

Highlights the previous highlightable item (or the last if nothing is currently highlighted).

code »

isEnabled() ⇒

Returns true if the container is enabled, false otherwise.

Returns:

Whether the container is enabled.

code »

isFocusable() ⇒

Returns true if the container is focusable, false otherwise. The default is true. Focusable containers always have a tab index and allocate a key handler to handle keyboard events while focused.

Returns:

Whether the component is focusable.

code »

isFocusableChildrenAllowed() ⇒

Returns true if the container allows children to be focusable, false otherwise. Only effective if the container is not focusable.

Returns:

Whether children should be focusable.

code »

isMouseButtonPressed() ⇒

Returns true if the mouse button is pressed, false otherwise.

Returns:

Whether the mouse button is pressed.

code »

isOpenFollowsHighlight() ⇒

No description.

Returns:

Whether highlighting a child component should also open it.

code »

isVisible() ⇒

Returns true if the container's visibility is set to visible, false if it is set to hidden. A container that is set to hidden is guaranteed to be hidden from the user, but the reverse isn't necessarily true. A container may be set to visible but can otherwise be obscured by another element, rendered off-screen, or hidden using direct CSS manipulation.

Returns:

Whether the container is set to be visible.

code »

registerChildId_(child)

Creates a DOM ID for the child control and registers it to an internal hash table to be able to find it fast by id.

Arguments:

child :

(goog.ui.Control | null)

The child control. Its root element has to be created yet.

code »

removeChild(control, opt_unrender) ⇒

(goog.ui.Control | null)

Removes a child control. Overrides goog.ui.Component#removeChild by updating the highlight index. Since goog.ui.Component#removeChildAt uses #removeChild internally, we only need to override this method.

Arguments:

control :

(goog.ui.Control | null | string)

The ID of the child to remove, or the control itself.

opt_unrender :

(boolean | undefined)

Whether to call exitDocument on the removed control, and detach its DOM from the document (defaults to false).

Returns:

(goog.ui.Control | null)

The removed control, if any.

code »

setEnabled(enable)

Enables/disables the container based on the enable argument. Dispatches an ENABLED or DISABLED event prior to changing the container&amp;#39;s state, which may be caught and canceled to prevent the container from changing state. Also enables/disables child controls.

Arguments:

enable :

Whether to enable or disable the container.

code »

setFocusable(focusable)

Sets whether the container is focusable. The default is true. Focusable containers always have a tab index and allocate a key handler to handle keyboard events while focused.

Arguments:

focusable :

Whether the component is to be focusable.

code »

setFocusableChildrenAllowed(focusable)

Sets whether the container allows children to be focusable, false otherwise. Only effective if the container is not focusable.

Arguments:

focusable :

Whether the children should be focusable.

code »

setHighlighted(item)

Highlights the given item if it exists and is a child of the container; otherwise un-highlights the currently highlighted item.

Arguments:

item :

(goog.ui.Control | null)

Item to highlight.

code »

setHighlightedIndex(index)

Highlights the item at the given 0-based index (if any). If another item was previously highlighted, it is un-highlighted.

Arguments:

index :

Index of item to highlight (-1 removes the current highlight).

code »

setHighlightedIndexFromKeyEvent(index)

Helper method that sets the highlighted index to the given index in response to a keyboard event. The base class implementation simply calls the #setHighlightedIndex method, but subclasses can override this behavior as needed.

Arguments:

index :

Index of item to highlight.

code »

setKeyEventTarget(element)

Attaches an element on which to listen for key events.

Arguments:

element :

(Element | null | undefined)

The element to attach, or null/undefined to attach to the default element.

code »

setMouseButtonPressed(pressed)

Sets or clears the "mouse button pressed" flag.

Arguments:

pressed :

Whether the mouse button is presed.

code »

setOpenFollowsHighlight(follow)

Sets whether highlighting a child component should also open it.

Arguments:

follow :

Whether highlighting a child component also opens it.

code »

setOrientation(orientation)

Sets the container's orientation.

Arguments:

orientation :

goog.ui.Container.Orientation.<string>

Container orientation.

code »

setRenderer(renderer)

Registers the given renderer with the container. Changing renderers after the container has already been rendered or decorated is an error.

Arguments:

renderer :

(goog.ui.ContainerRenderer | null)

Renderer used by the container.

code »

setVisible(visible, opt_force) ⇒

Shows or hides the container. Does nothing if the container already has the requested visibility. Otherwise, dispatches a SHOW or HIDE event as appropriate, giving listeners a chance to prevent the visibility change.

Arguments:

visible :

Whether to show or hide the container.

opt_force :

(boolean | undefined)

If true, doesn't check whether the container already has the requested visibility, and doesn't dispatch any events.

Returns:

Whether the visibility was changed.

code »

Defined in goog.ui.Component

addChild(child, opt_render)

Adds the specified component as the last child of this component. See goog.ui.Component#addChildAt for detailed semantics.

Arguments:

child :

(goog.ui.Component | null)

The new child component.

opt_render :

(boolean | undefined)

If true, the child component will be rendered into the parent.

code »

addChildAt(child, index, opt_render) ⇒

undefined

Adds the specified component as a child of this component at the given 0-based index. Both addChild and addChildAt assume the following contract between parent and child components:

the child component's element must be a descendant of the parent component's element, and
the DOM state of the child component must be consistent with the DOM state of the parent component (see isInDocument).

In particular, parent.addChild(child) will throw an error if the child component is already in the document, but the parent isn&#39;t. Clients of this API may call addChild and addChildAt with opt_render set to true. If opt_render is true, calling these methods will automatically render the child component&amp;amp;amp;amp;#39;s element into the parent component&amp;amp;amp;amp;#39;s element. However, parent.addChild(child, true) will throw an error if:

the parent component has no DOM (i.e. parent.getElement() is null), or
the child component is already in the document, regardless of the parent's DOM state.

If opt_render is true and the parent component is not already in the document, enterDocument will not be called on this component at this point. Finally, this method also throws an error if the new child already has a different parent, or the given index is out of bounds.

Arguments:

child :

(goog.ui.Component | null)

The new child component.

index :

0-based index at which the new child component is to be added; must be between 0 and the current child count (inclusive).

opt_render :

(boolean | undefined)

If true, the child component will be rendered into the parent.

Returns:

undefined

Nada.

code »

canDecorate(element) ⇒

Determines if a given element can be decorated by this type of component. This method should be overridden by inheriting objects.

Arguments:

element :

(Element | null)

Element to decorate.

Returns:

True if the element can be decorated, false otherwise.

code »

createDom()

Creates the initial DOM representation for the component. The default implementation is to set this.element_ = div.

code »

decorate(element)

Decorates the element for the UI component.

Arguments:

element :

(Element | null)

Element to decorate.

code »

decorateInternal(element)

Actually decorates the element. Should be overridden by inheriting objects. This method can assume there are checks to ensure the component has not already been rendered have occurred and that enter document will be called afterwards. This method is considered protected.

Arguments:

element :

(Element | null)

Element to decorate.

code »

disposeInternal()

Disposes of the component. Calls exitDocument, which is expected to remove event handlers and clean up the component. Propagates the call to the component's children, if any. Removes the component's DOM from the document unless it was decorated.

code »

enterDocument()

Called when the component's element is known to be in the document. Anything using document.getElementById etc. should be done at this stage. If the component contains child components, this call is propagated to its children.

code »

exitDocument()

Called by dispose to clean up the elements and listeners created by a component, or by a parent component/application who has removed the component from the document but wants to reuse it later. If the component contains child components, this call is propagated to its children. It should be possible for the component to be rendered again once this method has been called.

code »

forEachChild(f, opt_obj)

Calls the given function on each of this component's children in order. If opt_obj is provided, it will be used as the 'this' object in the function when called. The function should take two arguments: the child component and its 0-based index. The return value is ignored.

Arguments:

f :

(Function | null)

The function to call for every child component; should take 2 arguments (the child and its index).

opt_obj :

(Object | null | undefined)

Used as the 'this' object in f when called.

code »

getChild(id) ⇒

(goog.ui.Component | null)

Returns the child with the given ID, or null if no such child exists.

Arguments:

id :

Child component ID.

Returns:

(goog.ui.Component | null)

The child with the given ID; null if none.

code »

getChildAt(index) ⇒

(goog.ui.Component | null)

Returns the child at the given index, or null if the index is out of bounds.

Arguments:

index :

0-based index.

Returns:

(goog.ui.Component | null)

The child at the given index; null if none.

code »

getChildCount() ⇒

Returns the number of children of this component.

Returns:

The number of children.

code »

getChildIds() ⇒

(Array | null)

Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.

Returns:

(Array | null)

Child component IDs.

code »

getContentElement() ⇒

(Element | null)

Returns the DOM element into which child components are to be rendered, or null if the component itself hasn't been rendered yet. This default implementation returns the component's root element. Subclasses with complex DOM structures must override this method.

Returns:

(Element | null)

Element to contain child elements (null if none).

code »

getDomHelper() ⇒

goog.dom.DomHelper

Returns the dom helper that is being used on this component.

Returns:

goog.dom.DomHelper

The dom helper used on this component.

code »

getElement() ⇒

(Element | null)

Gets the component's element.

Returns:

(Element | null)

The element for the component.

code »

getElementByClass(className) ⇒

(Element | null)

Returns the first element in this component's DOM with the provided className.

Arguments:

className :

The name of the class to look for.

Returns:

(Element | null)

The first item with the class name provided.

code »

getElementByFragment(idFragment) ⇒

(Element | null)

Helper function for returning an element in the document with a unique id generated using makeId().

Arguments:

idFragment :

The partial id.

Returns:

(Element | null)

The element with the unique id, or null if it cannot be found.

code »

getElementsByClass(className) ⇒

{length: number}

Returns an array of all the elements in this component's DOM with the provided className.

Arguments:

className :

The name of the class to look for.

Returns:

{length: number}

The items found with the class name provided.

code »

getFragmentFromId(id) ⇒

Helper function for returning the fragment portion of an id generated using makeId().

Arguments:

id :

Id generated with makeId().

Returns:

Fragment.

code »

getHandler() ⇒

goog.events.EventHandler

Returns the event handler for this component, lazily created the first time this method is called.

Returns:

goog.events.EventHandler

Event handler for this component.

code »

getId() ⇒

Gets the unique ID for the instance of this component. If the instance doesn't already have an ID, generates one on the fly.

Returns:

Unique component ID.

code »

getModel() ⇒

Returns the model associated with the UI component.

Returns:

The model.

code »

getParent() ⇒

(goog.ui.Component | null)

Returns the component's parent, if any.

Returns:

(goog.ui.Component | null)

The parent component.

code »

hasChildren() ⇒

Returns true if the component has children.

Returns:

True if the component has children.

code »

indexOfChild(child) ⇒

Returns the 0-based index of the given child component, or -1 if no such child is found.

Arguments:

child :

(goog.ui.Component | null)

The child component.

Returns:

0-based index of the child component; -1 if not found.

code »

isInDocument() ⇒

Determines whether the component has been added to the document.

Returns:

TRUE if rendered. Otherwise, FALSE.

code »

isRightToLeft() ⇒

Returns true if the component is rendered right-to-left, false otherwise. The first time this function is invoked, the right-to-left rendering property is set if it has not been already.

Returns:

Whether the control is rendered right-to-left.

code »

makeId(idFragment) ⇒

Helper function for subclasses that gets a unique id for a given fragment, this can be used by components to generate unique string ids for DOM elements.

Arguments:

idFragment :

A partial id.

Returns:

Unique element id.

code »

makeIds(object) ⇒

(Object | null)

Makes a collection of ids. This is a convenience method for makeId. The object's values are the id fragments and the new values are the generated ids. The key will remain the same.

Arguments:

object :

(Object | null)

The object that will be used to create the ids.

Returns:

(Object | null)

An object of id keys to generated ids.

code »

removeChild(child, opt_unrender) ⇒

(goog.ui.Component | null)

Removes the given child from this component, and returns it. Throws an error if the argument is invalid or if the specified child isn't found in the parent component. The argument can either be a string (interpreted as the ID of the child component to remove) or the child component itself. If opt_unrender is true, calls goog.ui.component#exitDocument on the removed child, and subsequently detaches the child&#39;s DOM from the document. Otherwise it is the caller&#39;s responsibility to clean up the child component&#39;s DOM.

Arguments:

child :

(goog.ui.Component | null | string)

The ID of the child to remove, or the child component itself.

opt_unrender :

(boolean | undefined)

If true, calls exitDocument on the removed child component, and detaches its DOM from the document.

Returns:

(goog.ui.Component | null)

The removed component, if any.

code »

removeChildAt(index, opt_unrender) ⇒

(goog.ui.Component | null)

Removes the child at the given index from this component, and returns it. Throws an error if the argument is out of bounds, or if the specified child isn't found in the parent. See goog.ui.Component#removeChild for detailed semantics.

Arguments:

index :

0-based index of the child to remove.

opt_unrender :

(boolean | undefined)

If true, calls exitDocument on the removed child component, and detaches its DOM from the document.

Returns:

(goog.ui.Component | null)

The removed component, if any.

code »

removeChildren(opt_unrender)

Removes every child component attached to this one.

Arguments:

opt_unrender :

(boolean | undefined)

If true, calls #exitDocument on the removed child components, and detaches their DOM from the document.

code »

render(opt_parentElement)

Renders the component. If a parent element is supplied, the component's element will be appended to it. If there is no optional parent element and the element doesn't have a parentNode then it will be appended to the document body. If this component has a parent component, and the parent component is not in the document already, then this will not call enterDocument on this component. Throws an Error if the component is already rendered.

Arguments:

opt_parentElement :

(Element | null | undefined)

Optional parent element to render the component into.

code »

renderBefore(sibling)

Renders the component before another element. The other element should be in the document already. Throws an Error if the component is already rendered.

Arguments:

sibling :

(Node | null)

Node to render the component before.

code »

render_(opt_parentElement, opt_beforeNode)

Arguments:

opt_parentElement :

(Element | null | undefined)

Optional parent element to render the component into.

opt_beforeNode :

(Node | null | undefined)

Node before which the component is to be rendered. If left out the node is appended to the parent element.

code »

setElementInternal(element)

Sets the component's root element to the given element. Considered protected and final. This should generally only be called during createDom. Setting the element does not actually change which element is rendered, only the element that is associated with this UI component.

Arguments:

element :

(Element | null)

Root element for the component.

code »

setId(id)

Assigns an ID to this component instance. It is the caller's responsibility to guarantee that the ID is unique. If the component is a child of a parent component, then the parent component's child index is updated to reflect the new ID; this may throw an error if the parent already has a child with an ID that conflicts with the new ID.

Arguments:

id :

Unique component ID.

code »

setModel(obj)

Sets the model associated with the UI component.

Arguments:

obj :

The model.

code »

setParent(parent)

Sets the parent of this component to use for event bubbling. Throws an error if the component already has a parent or if an attempt is made to add a component to itself as a child. Callers must use removeChild or removeChildAt to remove components from their containers before calling this method.

Arguments:

parent :

(goog.ui.Component | null)

The parent component.

code »

setParentEventTarget(parent)

Overrides goog.events.EventTarget#setParentEventTarget to throw an error if the parent component is set, and the argument is not the parent.

Arguments:

parent :

No description.

code »

setRightToLeft(rightToLeft)

Set is right-to-left. This function should be used if the component needs to know the rendering direction during dom creation (i.e. before #enterDocument is called and is right-to-left is set).

Arguments:

rightToLeft :

Whether the component is rendered right-to-left.

code »

wasDecorated() ⇒

No description.

Returns:

Whether the component was decorated.

code »

Defined in goog.events.EventTarget

addEventListener(type, handler, opt_capture, opt_handlerScope)

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.

Arguments:

type :

The type of the event to listen for.

handler :

(Object | null)

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 | undefined)

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

opt_handlerScope :

(Object | null | undefined)

Object in whose scope to call the listener.

code »

dispatchEvent(e) ⇒

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.

Arguments:

e :

(Object | goog.events.Event | null | string)

Event object.

Returns:

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

code »

disposeInternal()

Unattach 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, it should be something like this:

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

code »

getParentEventTarget() ⇒

(goog.events.EventTarget | null)

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

Returns:

(goog.events.EventTarget | null)

The parent EventTarget or null if there is no parent.

code »

removeEventListener(type, handler, opt_capture, opt_handlerScope)

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 :

The type of the event to listen for.

handler :

(Object | null)

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 | undefined)

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

opt_handlerScope :

(Object | null | undefined)

Object in whose scope to call the listener.

code »

setParentEventTarget(parent)

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

Arguments:

parent :

(goog.events.EventTarget | null)

Parent EventTarget (null if none).

code »

Defined in goog.Disposable

dispose() ⇒

undefined

Disposes of the object. If the object hasn&#39;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:

undefined

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&#39; disposeInternal method. Everywhere else the public dispose method must be used. For example:

mypackage.MyClass = function() {
goog.base(this);
// Constructor logic specific to MyClass.
...
};
goog.inherits(mypackage.MyClass, goog.Disposable);

mypackage.MyClass.prototype.disposeInternal = function() {
goog.base(this, &#39;disposeInternal&#39;);
// Dispose logic specific to MyClass.
...
};

code »

getDisposed() ⇒

Use #isDisposed instead. No description.

Returns:

Whether the object has been disposed of.

code »

isDisposed() ⇒

No description.

Returns: