The goog.ui.ToolbarColorMenuButtonRenderer Class

Returns true if this renderer can decorate the element. Overrides {@link goog.ui.ButtonRenderer#canDecorate} by returning true if the element is a DIV, false otherwise.

.createButton(content, dom)

Takes a text caption or existing DOM structure, and returns the content and a dropdown arrow element wrapped in a pseudo-rounded-corner box. Creates the following DOM structure:

.createCaption(content, dom)

Overrides the superclass implementation by wrapping the caption text or DOM structure in a color indicator element. Creates the following DOM structure:

.createDom(control)

.createDropdown(dom)

Returns an appropriately-styled DIV containing a dropdown arrow element. Creates the following DOM structure:

.decorate(control, element)

Takes an element, decorates it with the menu button control, and returns the element. Overrides {@link goog.ui.CustomButtonRenderer#decorate} by looking for a child element that can be decorated by a menu, and if it finds one, decorates it and attaches it to the menu button.

.enableClassName(control, className, enable)

Updates the control's DOM by adding or removing the specified class name to/from its root element. May add additional combined classes as needed in IE6 and lower. Because of this, subclasses should use this method when modifying class names on the control's root element.

.enableExtraClassName(control, className, enable)

Updates the control's DOM by adding or removing the specified extra class name to/from its element.

.getAriaRole()

`.getClassForState(state)` [protected]

Inherited from goog.ui.ControlRenderer .

Takes a single {@link goog.ui.Component.State}, and returns the corresponding CSS class name (null if none).

state {goog.ui.Component.State}: Component state.
returns {string|undefined}: CSS class representing the given state (undefined if none).

`.getClassNames(control)` [protected]

Inherited from goog.ui.ControlRenderer .

Returns all CSS class names applicable to the given control, based on its state. The return value is an array of strings containing

the renderer-specific CSS class returned by {@link #getCssClass}, followed by
the structural CSS class returned by {@link getStructuralCssClass} (if different from the renderer-specific CSS class), followed by
any state-specific classes returned by {@link #getClassNamesForState}, followed by
any extra classes returned by the control's {@code getExtraClassNames} method and
for IE6 and lower, additional combined classes from {@link getAppliedCombinedClassNames_}.

Since all controls have at least one renderer-specific CSS class name, this method is guaranteed to return an array of at least one element.

control {goog.ui.Control}: Control whose CSS classes are to be returned.
returns {Array.<string>}: Array of CSS class names applicable to the control.

`.getClassNamesForState(state)` [protected]

Inherited from goog.ui.ControlRenderer .

Takes a bit mask of {@link goog.ui.Component.State}s, and returns an array of the appropriate class names representing the given state, suitable to be applied to the root element of a component rendered using this renderer, or null if no state-specific classes need to be applied. This default implementation uses the renderer's {@link getClassForState} method to generate each state-specific class.

state {number}: Bit mask of component states.
returns {!Array.<string>}: Array of CSS class names representing the given state.

.getContentElement(element)

Takes the button's root element and returns the parent element of the button's contents. Overrides the superclass implementation by taking the nested DIV structure of menu buttons into account.

.getCssClass()

Returns the CSS class to be applied to the root element of menu buttons rendered using this renderer.

.getIe6ClassCombinations()

Returns an array of combinations of classes to apply combined class names for in IE6 and below. See {@link IE6_CLASS_COMBINATIONS} for more detail. This method doesn't reference {@link IE6_CLASS_COMBINATIONS} so that it can be compiled out, but subclasses should return their IE6_CLASS_COMBINATIONS static constant instead.

.getKeyEventTarget(control)

Returns the element within the component's DOM that should receive keyboard focus (null if none). The default implementation returns the control's root element.

`.getStateFromClass(className)` [protected]

Inherited from goog.ui.ControlRenderer .

Takes a single CSS class name which may represent a component state, and returns the corresponding component state (0x00 if none).

className {string}: CSS class name, possibly representing a component state.
returns {goog.ui.Component.State}: state Component state corresponding to the given CSS class (0x00 if none).

.getStructuralCssClass()

Returns the name of a DOM structure-specific CSS class to be applied to the root element of all components rendered or decorated using this renderer. Unlike the class name returned by {@link #getCssClass}, the structural class name may be shared among different renderers that generate similar DOM structures. The structural class name also serves as the basis of derived class names used to identify and style structural elements of the control's DOM, as well as the basis for state-specific class names. The default implementation returns the same class name as {@link #getCssClass}, but subclasses are expected to override this method as needed.

.getTooltip(element)

.getValue

Takes a button's root element, and returns the value associated with it. No-op in the base class.

`.hasBoxStructure(button, element)` [protected]

Inherited from goog.ui.CustomButtonRenderer .

Check if the button's element has a box structure.

button {goog.ui.Button}: Button instance whose structure is being checked.
element {Element}: Element of the button.
returns {boolean}: Whether the element has a box structure.

.initializeDom(button)

Initializes the button's DOM when it enters the document. Overrides the superclass implementation by making sure the button's color indicator is initialized.

.isFocusable(control)

Returns true if the control's key event target supports keyboard focus (based on its {@code tabIndex} attribute), false otherwise.

.setAllowTextSelection(element, allow)

.setAriaRole(element, opt_preferredRole)

.setAriaStates(control, element)

Sets the element's ARIA states. An element does not need an ARIA role in order to have an ARIA state. Only states which are initialized to be true will be set.

`.setCollapsed(button, sides)` [protected]

Inherited from goog.ui.ButtonRenderer .

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

button {goog.ui.Button}: Button to update.
sides {number}: Bitmap of one or more {@link goog.ui.ButtonSide}s for which borders should be collapsed.

.setContent(element, content)

Takes the menubutton's root element, and sets its content to the given text caption or DOM structure. Because the DOM structure of this button is conditional based on whether we need to work around FF2/RTL bugs, we override the default implementation to take this into account.

.setFocusable(control, focusable)

Updates the control's key event target to make it focusable or non-focusable via its {@code tabIndex} attribute. Does nothing if the control doesn't support the {@code FOCUSED} state, or if it has no key event target.

.setRightToLeft(element, rightToLeft)

Applies special styling to/from the control's element if it is rendered right-to-left, and removes it if it is rendered left-to-right.

.setState(control, state, enable)

`.setTooltip(element, tooltip)` [protected]

Inherited from goog.ui.ButtonRenderer .

Takes a button's root element and a tooltip string, and updates the element with the new tooltip.

element {Element}: The button's root element.
tooltip {string}: New tooltip text.

.setValue(element, value)

Takes a color menu button control's root element and a value object (which is assumed to be a color), and updates the button's DOM to reflect the new color. Overrides {@link goog.ui.ButtonRenderer#setValue}.

.setVisible(element, visible)

`.updateAriaState(element, state, enable)` [protected]

Inherited from goog.ui.ButtonRenderer .

Updates the button's ARIA (accessibility) state if the button is being treated as a checkbox.

element {Element}: Element whose ARIA state is to be updated.
state {goog.ui.Component.State}: Component state being enabled or disabled.
enable {boolean}: Whether the state is being enabled or disabled.

The `goog.ui.ToolbarColorMenuButtonRenderer` Class

`goog.ui.ToolbarColorMenuButtonRenderer()`

`.canDecorate(element)`

`.createButton(content, dom)`

`.createCaption(content, dom)`

`.createDom(control)`

`.createDropdown(dom)`

`.decorate(control, element)`

`.enableClassName(control, className, enable)`

`.enableExtraClassName(control, className, enable)`

`.getAriaRole()`

`.getClassForState(state)` [protected]

`.getClassNames(control)` [protected]

`.getClassNamesForState(state)` [protected]

`.getContentElement(element)`

`.getCssClass()`

`.getIe6ClassCombinations()`

`.getKeyEventTarget(control)`

`.getStateFromClass(className)` [protected]

`.getStructuralCssClass()`

`.getTooltip(element)`

`.getValue`

`.hasBoxStructure(button, element)` [protected]

`.initializeDom(button)`

`.isFocusable(control)`

`.setAllowTextSelection(element, allow)`

`.setAriaRole(element, opt_preferredRole)`

`.setAriaStates(control, element)`

`.setCollapsed(button, sides)` [protected]

`.setContent(element, content)`

`.setFocusable(control, focusable)`

`.setRightToLeft(element, rightToLeft)`

`.setState(control, state, enable)`

`.setTooltip(element, tooltip)` [protected]

`.setValue(element, value)`

`.setVisible(element, visible)`

`.updateAriaState(element, state, enable)` [protected]

The goog.ui.ToolbarColorMenuButtonRenderer Class

goog.ui.ToolbarColorMenuButtonRenderer()

.canDecorate(element)

.createButton(content, dom)

.createCaption(content, dom)

.createDom(control)

.createDropdown(dom)

.decorate(control, element)

.enableClassName(control, className, enable)

.enableExtraClassName(control, className, enable)

.getAriaRole()

.getClassForState(state) [protected]

.getClassNames(control) [protected]

.getClassNamesForState(state) [protected]

.getContentElement(element)

.getCssClass()

.getIe6ClassCombinations()

.getKeyEventTarget(control)

.getStateFromClass(className) [protected]

.getStructuralCssClass()

.getTooltip(element)

.getValue

.hasBoxStructure(button, element) [protected]

.initializeDom(button)

.isFocusable(control)

.setAllowTextSelection(element, allow)

.setAriaRole(element, opt_preferredRole)

.setAriaStates(control, element)

.setCollapsed(button, sides) [protected]

.setContent(element, content)

.setFocusable(control, focusable)

.setRightToLeft(element, rightToLeft)

.setState(control, state, enable)

.setTooltip(element, tooltip) [protected]

.setValue(element, value)

.setVisible(element, visible)

.updateAriaState(element, state, enable) [protected]

The `goog.ui.ToolbarColorMenuButtonRenderer` Class

`goog.ui.ToolbarColorMenuButtonRenderer()`

`.canDecorate(element)`

`.createButton(content, dom)`

`.createCaption(content, dom)`

`.createDom(control)`

`.createDropdown(dom)`

`.decorate(control, element)`

`.enableClassName(control, className, enable)`

`.enableExtraClassName(control, className, enable)`

`.getAriaRole()`

`.getClassForState(state)` [protected]

`.getClassNames(control)` [protected]

`.getClassNamesForState(state)` [protected]

`.getContentElement(element)`

`.getCssClass()`

`.getIe6ClassCombinations()`

`.getKeyEventTarget(control)`

`.getStateFromClass(className)` [protected]

`.getStructuralCssClass()`

`.getTooltip(element)`

`.getValue`

`.hasBoxStructure(button, element)` [protected]

`.initializeDom(button)`

`.isFocusable(control)`

`.setAllowTextSelection(element, allow)`

`.setAriaRole(element, opt_preferredRole)`

`.setAriaStates(control, element)`

`.setCollapsed(button, sides)` [protected]

`.setContent(element, content)`

`.setFocusable(control, focusable)`

`.setRightToLeft(element, rightToLeft)`

`.setState(control, state, enable)`

`.setTooltip(element, tooltip)` [protected]

`.setValue(element, value)`

`.setVisible(element, visible)`

`.updateAriaState(element, state, enable)` [protected]