goog.ui.ColorMenuButton

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

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 the steady state -- the exception is to addChildAt(child, i, false) and then immediately decorate/render the child.

In particular, parent.addChild(child) will throw an error if the child component is already in the document, but the parent isn'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's element into the parent component's element. If the parent does not yet have an element, then createDom will automatically be invoked on the parent before rendering the child.

Invoking parent.addChild(child, true) will throw an error if 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.

Adds the given class name to the list of classes to be applied to the component's root element.

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

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

Returns true if the given element is to be considered part of the component, even if it isn't a DOM descendant of the component's root element.

Creates the control's DOM. Overrides goog.ui.Component#createDom by delegating DOM manipulation to the control's renderer.

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.

Decorates the given element with this component. Overrides goog.ui.Component#decorateInternal by delegating DOM manipulation to the control's renderer.

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.

Adds or removes the given class name to/from the list of classes to be applied to the component's root element.

Sets up event handlers specific to menu buttons.

Removes event handlers specific to menu buttons, and ensures that the attached menu also exits the document.

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.

Gets the control's aria label.

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

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

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 text caption or DOM structure displayed in the component.

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

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.

Returns any additional class name(s) to be applied to the component's root element, or null if no extra class names are needed.

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.

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

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

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

Returns the keyboard event handler for this component, lazily created the first time this method is called. Considered protected; should only be used within this package and by subclasses.

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 menu attached to the button. If no menu is attached, creates a new empty menu.

Returns the model associated with the UI component.

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.

Returns the control's preferred ARIA role. This can be used by a control to override the role that would be assigned by the renderer. This is useful in cases where a different ARIA role is appropriate for a control because of the context in which it's used. E.g., a goog.ui.MenuButton added to a goog.ui.Select should have an ARIA role of LISTBOX and not MENUITEM.

Returns the renderer used by this component 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.

Returns the currently selected color (null if none).

Returns the component's state as a bit mask of goog.ui.Component.States.

Returns the tooltip for the button.

Returns the value associated with the button.

Handles blur events dispatched by the button's key event target when it loses keyboard focus by closing the popup menu (unless it is focusable). Only registered if the button is focusable.

Handles CLOSE events dispatched by the associated menu.

Handles contextmenu events.

Handles dblclick events. Should only be registered if the user agent is IE. If the component is enabled, performs its associated action by calling performActionInternal. This is used to allow more performant buttons in IE. In IE, no mousedown event is fired when that mousedown will trigger a dblclick event. Because of this, a user clicking quickly will only cause ACTION events to fire on every other click. This is a workaround to generate ACTION events for every click. Unfortunately, this workaround won't ever trigger the ACTIVE state. This is roughly the same behaviour as if this were a 'button' element with a listener on mouseup. Considered protected; should only be used within this package and by subclasses.

Handles mousedown events over the document. If the mousedown happens over an element unrelated to the component, hides the menu. TODO(attila): Reconcile this with goog.ui.Popup (and handle frames/windows).

Handles focus events on the component's key event target element. If the component is focusable, updates its state and styling to indicate that it now has keyboard focus. Considered protected; should only be used within this package and by subclasses. Warning: IE dispatches focus and blur events asynchronously!

Handles HIGHLIGHT events dispatched by the attached menu.

Attempts to handle a keyboard event, if the component is enabled and visible, 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 button is enabled and the Enter/Space key was pressed, handles the event by dispatching an ACTION event, and returns true. Overrides goog.ui.Control#handleKeyEventInternal.

Handles goog.ui.Component.EventType.ACTION events dispatched by the menu item clicked by the user. Updates the button, calls the superclass implementation to hide the menu, stops the propagation of the event, and dispatches an ACTION event on behalf of the button itself. Overrides goog.ui.MenuButton#handleMenuAction.

Handles BLUR events dispatched by the popup menu by closing it. Only registered if the menu is focusable.

Handles mousedown events. Invokes the superclass implementation to dispatch an ACTIVATE event and activate the button. Also toggles the visibility of the attached menu.

Handles mouseout events. Dispatches a LEAVE event; if the event isn't canceled, and the component supports auto-highlighting, deactivates and un-highlights the component. Considered protected; should only be used within this package and by subclasses.

Handles mouseover events. Dispatches an ENTER event; if the event isn't canceled, the component is enabled, and it supports auto-highlighting, highlights the component. Considered protected; should only be used within this package and by subclasses.

Handles mouseup events. Invokes the superclass implementation to dispatch an ACTION event and deactivate the button.

Handles UNHIGHLIGHT events dispatched by the associated menu.

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.

Returns true if the component is in the specified state, false otherwise.

Hides the menu and cleans up menu-specific event handling.

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

Resets the MenuButton's size. This is useful for cases where items are added or removed from the menu and scrollOnOverflow is on. In those cases the menu will not behave correctly and resize itself unless this is called (usually followed by positionMenu()).

Returns true if the component is active (pressed), false otherwise.

Returns true if the control allows text selection within its DOM, false otherwise. Controls that disallow text selection have the appropriate unselectable styling applied to their elements. Note that controls hosted in containers will report that they allow text selection even if their container disallows text selection.

Returns true if the component provides default event handling for the state, false otherwise.

Returns true if the component is checked, false otherwise.

Returns true if the component is set to dispatch transition events for the given state, false otherwise.

Returns true if the component is enabled, false otherwise.

Returns true if the component is styled to indicate that it has keyboard focus, false otherwise. Note that isFocused() returning true doesn't guarantee that the component's key event target has keyboard focus, only that it is styled as such.

Returns true if the control is configured to handle its own mouse events, false otherwise. Controls not hosted in goog.ui.Containers have to handle their own mouse events, but controls hosted in containers may allow their parent to handle mouse events on their behalf. Considered protected; should only be used within this package and by subclasses.

Returns true if the component is currently highlighted, false otherwise.

Determines whether the component has been added to the document.

Returns true if the component is open (expanded), false otherwise.

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 component is selected, false otherwise.

Returns true if the component supports the specified state, false otherwise.

Returns true if the transition into or out of the given state is allowed to proceed, false otherwise. A state transition is allowed under the following conditions:

• the component supports the state,
• the component isn't already in the target state,
• either the component is configured not to dispatch events for this state transition, or a transition event was dispatched and wasn't canceled by any event listener, and
• the component hasn't been disposed of

Returns true if the component's visibility is set to visible, false if it is set to hidden. A component that is set to hidden is guaranteed to be hidden from the user, but the reverse isn't necessarily true. A component 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.

Performs the appropriate action when the menu button is activated by the user. Overrides the superclass implementation by not dispatching an ACTION event, because menu buttons exist only to reveal menus, not to perform actions themselves. Calls #setActive to deactivate the button.

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

Positions the menu under the button. May be called directly in cases when the menu size is known to change.

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 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's DOM from the document. Otherwise it is the caller's responsibility to clean up the child component's DOM.

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 the given class name from the list of classes to be applied to the component's root element.

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 the item from the menu and disposes of it.

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

Activates or deactivates the component. Does nothing if this state transition is disallowed.

Sets whether the menu is aligned to the start or the end of the button.

Allows or disallows text selection within the control's DOM.

Sets the control's aria label. This can be used to assign aria label to the element after it is rendered.

Enables or disables automatic event handling for the given state(s).

Sets the text caption of the component.

Checks or unchecks the component. Does nothing if this state transition is disallowed.

Sets whether the enter or space key should close the menu, if it is already open. By default, only the ESC key will close an open menu.

Collapses the border on one or both sides of the button, allowing it to be combined with the adjancent button(s), forming a single UI componenet with multiple targets.

Sets the component's content to the given text caption, element, or array of nodes. (If the argument is an array of nodes, it must be an actual array, not an array-like object.)

Sets the component's content to the given text caption, element, or array of nodes. Unlike #setContent, doesn't modify the component's DOM. Called by renderers during element decoration.

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

Enables or disables transition events for the given state(s). Controls handle state transitions internally by default, and only dispatch state transition events if explicitly requested to do so by calling this method.

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 menu button based on the value of the argument, and updates its CSS styling. Also hides the popup menu if the button is being disabled.

Sets whether the attached popup menu is focusable. If the popup menu is focusable, it may steal keyboard focus from the menu button, so the button will not hide the menu on blur.

Applies or removes styling indicating that the component has keyboard focus. Note that unlike the other "set" methods, this method is called as a result of the component's element having received or lost keyboard focus, not the other way around, so calling setFocused(true) doesn't guarantee that the component's key event target has keyboard focus, only that it is styled as such.

Enables or disables mouse event handling for the control. Containers may use this method to disable mouse event handling in their child controls. Considered protected; should only be used within this package and by subclasses.

Highlights or unhighlights the component. Does nothing if this state transition is disallowed.

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.

Replaces the menu attached to the button with the argument, and returns the previous menu (if any).

Sets a margin that will be applied to the menu's position when it is shown. If null, no margin will be applied.

Specify which positioning algorithm to use.

This method is preferred over the fine-grained positioning methods like setPositionElement, setAlignMenuToStart, and setScrollOnOverflow. Calling this method will override settings by those methods.

Sets the model associated with the UI component.

Opens or closes the menu. Overrides goog.ui.MenuButton#setOpen by generating a default color menu on the fly if needed.

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 an element for anchoring the menu.

Sets the control's preferred ARIA role. This can be used to override the role that would be assigned by the renderer. This is useful in cases where a different ARIA role is appropriate for a control because of the context in which it's used. E.g., a goog.ui.MenuButton added to a goog.ui.Select should have an ARIA role of LISTBOX and not MENUITEM.

Sets whether to render the menu as a sibling element of the button. Normally, the menu is a child of document.body. This option is useful if you need the menu to inherit styles from a common parent element, or if you otherwise need it to share a parent element for desired event handling. One example of the latter is if the parent is in a goog.ui.Popup, to ensure that clicks on the menu are considered being within the popup.

Registers the given renderer with the component. Changing renderers after the component has entered the document 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 menu should scroll when it's too big to fix vertically on the screen. The css of the menu element should have overflow set to auto. Note: Adding or removing items while the menu is open will not work correctly if scrollOnOverflow is on.

Sets whether to select the first item in the menu when it is opened using enter or space. By default, the first item is selected only when opened by a key up or down event. When this is on, the first item will be selected due to any of the four events.

Selects or unselects the component. Does nothing if this state transition is disallowed.

Sets the selected color, or clears the selected color if the argument is null or not any of the available color choices.

Sets or clears the given state on the component, and updates its styling accordingly. Does nothing if the component is already in the correct state or if it doesn't support the specified state. Doesn't dispatch any state transition events; use advisedly.

Sets the component's state to the state represented by a bit mask of goog.ui.Component.States. Unlike #setState, doesn't update the component's styling, and doesn't reject unsupported states. Called by renderers during element decoration. Considered protected; should only be used within this package and by subclasses.

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

Enables or disables support for the given state. Disabling support for a state while the component is in that state is an error.

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

Sets the tooltip for the button, and updates its DOM.

Sets the tooltip for the button. Unlike #setTooltip, doesn't update the button's DOM. Considered protected; to be called only by renderer code during element decoration.

Sets the value associated with the color menu button. Overrides goog.ui.Button#setValue by interpreting the value as a color spec string.

Sets the value associated with the button. Unlike #setValue, doesn't update the button's DOM. Considered protected; to be called only by renderer code during element decoration.

Shows/hides the menu button based on the value of the argument. Also hides the popup menu if the button is being hidden.

Reveals the menu and hooks up menu-specific event handling.

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

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.

No information.

Factory method that creates and returns a new goog.ui.Menu instance containing default color palettes.

Value for the "no color" menu item object in the color menu (if present). The goog.ui.ColorMenuButton#handleMenuAction method interprets ACTION events dispatched by an item with this value as meaning "clear the selected color."

Default color palettes.