goog.ui.PopupMenu

Adds the specified control as the last child of this container. See goog.ui.Container#addChildAt for detailed semantics.

Adds the control as a child of this container at the given 0-based index. Overrides goog.ui.Component#addChildAt by also updating the container's highlight index. Since goog.ui.Component#addChild uses #addChildAt internally, we only need to override this method.

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.

Adds a new menu item at the end of the menu.

Adds a new menu item at a specific index in the menu.

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.

Attaches the menu to a new popup position and anchor element. A menu can only be attached to an element once, since attaching the same menu for multiple positions doesn't make sense.

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

Returns whether the given item can be highlighted.

Returns whether the provided element is to be considered inside the menu for purposes such as dismissing the menu on an event. This is so submenus can make use of elements outside their own DOM.

Creates an object describing how the popup menu should be attached to the anchoring element based on the given parameters. The created object is stored, keyed by element and is retrievable later by invoking #getAttachTarget(element) at a later point.

Subclass may add more properties to the returned object, as needed.

Creates the container's DOM.

Decorates the element for the UI component. If the element is in the document, the enterDocument method will be called.

If goog.ui.Component.ALLOW_DETACHED_DECORATION is false, the caller must pass an element that is in the document.

Decorate menu items located in any descendant node which as been explicitly marked as a 'content' node.

Decorate an existing HTML structure with the menu. Menu items will be constructed from elements with classname 'goog-menuitem', separators will be made from HR elements.

Detaches a menu from a given element.

Detaches all listeners

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.

Disposes of the object and its resources.

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.

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

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

Fires all registered listeners in this listenable for the given type and capture mode, passing them the given eventObject. This does not perform actual capture/bubble. Only implementors of the interface should be using this.

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.

Returns the object describing how the popup menu should be attach to given element or null. The object is created and the association is formed when #attach is invoked.

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

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

Returns the number of children of this component.

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

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 the CSS class applied to menu elements, also used as the prefix for derived styles, if any. Subclasses should override this method as needed. Considered protected.

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

Gets the component's element.

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

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

Gets the component's element. This differs from getElement in that it assumes that the element exists (i.e. the component has been rendered/decorated) and will cause an assertion error otherwise (if assertion is enabled).

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

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

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

Returns the currently highlighted item (if any).

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

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 a reference to the menu item at a given index.

Returns the number of items in the menu (including separators).

Returns an array containing the menu items contained in the menu.

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

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.

Gets the goog.events.ListenableKey for the event or null if no such listener is in use.

Gets all listeners in this listenable for the given type and capture mode.

Returns the model associated with the UI component.

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

Returns the container's orientation.

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

Returns the component's parent, if any.

Returns the parent of this event target to use for capture/bubble mechanism.

NOTE(chrishenry): The name reflects the original implementation of custom event target (goog.events.EventTarget). We decided that changing the name is not worth it.

Gets the page offset of the menu, or null if the menu isn't visible

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

Similar to getElementByClass except that it expects the element to be present in the dom thus returning a required value. Otherwise, will assert.

Gets whether the browser context menu will override the menu activation when the shift key is held down.

Gets whether the menu is in toggle mode

Handles the key event target losing focus.

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.

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

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

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

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

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

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.

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.

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

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

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

Returns true if the component has children.

Whether there is any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Hides the menu.

Highlights the first highlightable item in the container

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

Highlights the last highlightable item in the container.

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

Highlights the next item that begins with the specified string. If no (other) item begins with the given string, the selection is unchanged.

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

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

Returns true if the container is enabled, false otherwise.

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 true if the container allows children to be focusable, false otherwise. Only effective if the container is not focusable.

Determines whether the component has been added to the document.

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

Returns whether the menu is currently visible or was visible within about 150 ms ago. This stops the menu toggling back on if the toggleMode == false.

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

Adds an event listener. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Adds an event listener that is removed automatically after the listener fired once.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

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.

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.

Handles click events that propagate to the document.

Returns whether this component should listen for PointerEvent types rather than MouseEvent types. This allows supporting drag gestures for touch/stylus input.

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

Removes all listeners from this listenable. If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

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.

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.

Removes every child component attached to this one and returns them.

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.

Removes an item from the menu and disposes of it.

Removes a menu item at a given index in the menu and disposes of it.

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.

Renders the component before another element. The other element should be in the document already.

Throws an Error if the component is already rendered.

Sets whether the menu can automatically move focus to its key event target when it is set to visible.

Sets whether the menu will highlight disabled menu items or skip to the next active item.

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.

This should only be used by subclasses and its associated renderers.

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

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.

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

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

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

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.

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.

Attaches an element on which to listen for key events.

Sets the model associated with the UI component.

Sets or clears the "mouse button pressed" flag.

Sets whether highlighting a child component should also open it.

Sets the container's orientation.

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.

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

Indicates whether this component should listen for PointerEvent types rather than MouseEvent types. This allows supporting drag gestures for touch/stylus input. Must be called before enterDocument to listen for the correct event types.

Sets the position of the menu relative to the view port.

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

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

Sets whether the browser context menu will override the menu activation when the shift key is held down.

Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.

Sets whether the menu should toggle if it is already open. For context menus this should be false, for toolbar menus it makes more sense to be true.

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.

Shows the menu immediately at the given client coordinates.

Shows the menu immediately attached to the given element

Show the menu at a given attached target.

Show the menu using given positioning object.

Removes an event listener which was added with listen() or listenOnce().

Removes an event listener which was added with listen() by the key returned by listen().

Used to stop the menu toggling back on if the toggleMode == false.

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

DomHelper used to interact with the document, allowing components to be created in a different window.

Coordinates of the mousedown event that caused this menu to be made visible. Used to prevent the consequent mouseup event due to a simple click from activating a menu item immediately. Considered protected; should only be used within this package or by subclasses.