• index
• goog
• ui
• search: Go

The goog.ui.CustomButtonRenderer Class

goog.ui.CustomButtonRenderer
> goog.ui.ButtonRenderer
> goog.ui.ControlRenderer

goog.ui.CustomButtonRenderer()

Custom renderer for {@link goog.ui.Button}s. Custom buttons can contain almost arbitrary HTML content, will flow like inline elements, but can be styled like block-level elements.

.CSS_CLASS {string}

Default CSS class to be applied to the root element of components rendered by this renderer.

.canDecorate(element)

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.

element {Element}

Element to decorate.

returns {boolean}

Whether the renderer can decorate the element.

.createButton(content, dom)

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

content {goog.ui.ControlContent}

Text caption or DOM structure to wrap in a box.

dom {goog.dom.DomHelper}

DOM helper, used for document interaction.

returns {Element}

Pseudo-rounded-corner box containing the content.

.createDom(control)

Returns the button's contents wrapped in the following DOM structure:

control {goog.ui.Control}

goog.ui.Button to render.

returns {Element}

Root element for the button.

.decorate(control, element)

Takes an existing element and decorates it with the custom button control. Initializes the control's ID, content, tooltip, value, and state based on the ID of the element, its child nodes, and its CSS classes, respectively. Returns the element. Overrides {@link goog.ui.ButtonRenderer#decorate}.

control {goog.ui.Control}

Button instance to decorate the element.

element {Element}

Element to decorate.

returns {Element}

Decorated element.

@suppress

{visibility} setContentInternal and setStateInternal

.enableClassName(control, className, enable)

Inherited from goog.ui.ControlRenderer .

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.

control {goog.ui.Control|Element}

Control instance (or root element) to be updated.

className {string}

CSS class name to add or remove.

enable {boolean}

Whether to add or remove the class name.

.enableExtraClassName(control, className, enable)

Inherited from goog.ui.ControlRenderer .

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

control {goog.ui.Control}

Control to be updated.

className {string}

CSS class name to add or remove.

enable {boolean}

Whether to add or remove the class name.

.getAriaRole()

Returns the ARIA role to be applied to custom buttons.

returns {goog.dom.a11y.Role|undefined}

ARIA role.

.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 custom buttons into account.

element {Element}

Root element of the button whose content element is to be returned.

returns {Element}

The button's content element (if any).

.getCssClass()

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

returns {string}

Renderer-specific CSS class.

.getIe6ClassCombinations()

Inherited from goog.ui.ControlRenderer .

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.

returns {Array.<Array.<string>>}

Array of class name combinations.

.getKeyEventTarget(control)

Inherited from goog.ui.ControlRenderer .

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.

control {goog.ui.Control}

Control whose key event target is to be returned.

returns {Element}

The key event target.

.getStructuralCssClass()

Inherited from goog.ui.ControlRenderer .

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.

returns {string}

DOM structure-specific CSS class name (same as the renderer- specific CSS class name by default).

.getTooltip(element)

Inherited from goog.ui.ButtonRenderer .

Takes a button's root element, and returns its tooltip text.

element {Element}

The button's root element.

returns {string|undefined}

The tooltip text.

.getValue

Inherited from goog.ui.ButtonRenderer .

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

element {Element}

The button's root element.

returns {string|undefined}

The button's value (undefined if none).

.initializeDom(control)

Inherited from goog.ui.ControlRenderer .

Initializes the control's DOM by configuring properties that can only be set after the DOM has entered the document. This implementation sets up BiDi and keyboard focus. Called from {@link goog.ui.Control#enterDocument}.

control {goog.ui.Control}

Control whose DOM is to be initialized as it enters the document.

.isFocusable(control)

Inherited from goog.ui.ControlRenderer .

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

control {goog.ui.Control}

Control whose key event target is to be checked.

returns {boolean}

Whether the control's key event target is focusable.

.setAllowTextSelection(element, allow)

Inherited from goog.ui.ControlRenderer .

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

element {Element}

The control's root element.

allow {boolean}

Whether the element should allow text selection.

.setAriaRole(element, opt_preferredRole)

Inherited from goog.ui.ControlRenderer .

Sets the element's ARIA role.

element {Element}

Element to update.

opt_preferredRole {?goog.dom.a11y.Role=}

The preferred ARIA role.

.setAriaStates(control, element)

Inherited from goog.ui.ControlRenderer .

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.

control {!goog.ui.Control}

Control whose ARIA state will be updated.

element {!Element}

Element whose ARIA state is to be updated.

.setContent(element, content)

Inherited from goog.ui.ControlRenderer .

Takes a control's root element, and sets its content to the given text caption or DOM structure. The default implementation replaces the children of the given element. Renderers that create more complex DOM structures must override this method accordingly.

element {Element}

The control's root element.

content {goog.ui.ControlContent}

Text caption or DOM structure to be set as the control's content. The DOM nodes will not be cloned, they will only moved under the content element of the control.

.setFocusable(control, focusable)

Inherited from goog.ui.ControlRenderer .

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.

control {goog.ui.Control}

Control whose key event target is to be updated.

focusable {boolean}

Whether to enable keyboard focus support on the control's key event target.

.setRightToLeft(element, rightToLeft)

Inherited from goog.ui.ControlRenderer .

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.

element {Element}

The control's root element.

rightToLeft {boolean}

Whether the component is rendered right-to-left.

.setState(control, state, enable)

Inherited from goog.ui.ControlRenderer .

Updates the appearance of the control in response to a state change.

control {goog.ui.Control}

Control instance to update.

state {goog.ui.Component.State}

State to enable or disable.

enable {boolean}

Whether the control is entering or exiting the state.

.setValue

Inherited from goog.ui.ButtonRenderer .

Takes a button's root element and a value, and updates the element to reflect the new value. No-op in the base class.

element {Element}

The button's root element.

value {string}

New value.

.setVisible(element, visible)

Inherited from goog.ui.ControlRenderer .

Shows or hides the element.

element {Element}

Element to update.

visible {boolean}

Whether to show the element.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.