ui.ControlRenderer Extends Object
Default renderer for {@link goog.ui.Control}s. Can be used as-is, but subclasses of Control will probably want to use renderers specifically tailored for them by extending this class. Controls that use renderers delegate one or more of the following API methods to the renderer:
  • {@code createDom} - renders the DOM for the component
  • {@code canDecorate} - determines whether an element can be decorated by the component
  • {@code decorate} - decorates an existing element with the component
  • {@code setState} - updates the appearance of the component based on its state
  • {@code getContent} - returns the component's content
  • {@code setContent} - sets the component's content
Controls are stateful; renderers, on the other hand, should be stateless and reusable.

Inheritance

Object
     goog.ui.ControlRenderer

Constructor

goog.ui.ControlRenderer()

Instance Methods

Public Protected Private
Defined in goog.ui.ControlRenderer
canDecorate(element) ⇒
boolean
Returns true if this renderer can decorate the element, false otherwise. The default implementation always returns true.
Arguments:
element :
Element
Element to decorate.
Returns: 
boolean
  Whether the renderer can decorate the element.
code »
createClassByStateMap_()
Creates the lookup table of states to classes, used during state changes.
code »
createDom(control) ⇒
Element
Returns the control's contents wrapped in a DIV, with the renderer's own CSS class and additional state-specific classes applied to it.
Arguments:
control :
goog.ui.Control
Control to render.
Returns: 
Element
  Root element for the control.
code »
createStateByClassMap_()
Creates the lookup table of classes to states, used during decoration.
code »
decorate(control, element) ⇒
Element
Default implementation of {@code decorate} for {@link goog.ui.Control}s. Initializes the control's ID, content, and state based on the ID of the element, its child nodes, and its CSS classes, respectively. Returns the element.
Arguments:
control :
goog.ui.Control
Control instance to decorate the element.
element :
Element
Element to decorate.
Returns: 
Element
  Decorated element.
code »
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.
Arguments:
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.
code »
enableExtraClassName(control, className, enable)
Updates the control's DOM by adding or removing the specified extra class name to/from its element.
Arguments:
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.
code »
getAppliedCombinedClassNames_(classes, opt_includedClass) ⇒
Array.<string>
Returns an array of all the combined class names that should be applied based on the given list of classes. Checks the result of {@link getIe6ClassCombinations} for any combinations that have all members contained in classes. If a combination matches, the members are joined with an underscore (in order), and added to the return array. If opt_includedClass is provided, return only the combined classes that have all members contained in classes AND include opt_includedClass as well. opt_includedClass is added to classes as well.
Arguments:
classes :
Array.<string>
Array of classes to return matching combined classes for.
opt_includedClass :
?string
If provided, get only the combined classes that include this one.
Returns: 
Array.<string>
  Array of combined class names that should be applied.
code »
getAriaRole() ⇒
goog.dom.a11y.Role | undefined
Returns the ARIA role to be applied to the control. See http://wiki/Main/ARIA for more info.
Returns: 
goog.dom.a11y.Role | undefined
  ARIA role.
code »
getClassForState(state) ⇒
string | undefined
Takes a single {@link goog.ui.Component.State}, and returns the corresponding CSS class name (null if none).
Arguments:
state :
goog.ui.Component.State
Component state.
Returns: 
string | undefined
  CSS class representing the given state (undefined if none).
code »
getClassNames(control) ⇒
Array.<string>
Returns all CSS class names applicable to the given control, based on its state. The return value is an array of strings containing
  1. the renderer-specific CSS class returned by {@link #getCssClass}, followed by
  2. the structural CSS class returned by {@link getStructuralCssClass} (if different from the renderer-specific CSS class), followed by
  3. any state-specific classes returned by {@link #getClassNamesForState}, followed by
  4. any extra classes returned by the control's {@code getExtraClassNames} method and
  5. 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.
Arguments:
control :
goog.ui.Control
Control whose CSS classes are to be returned.
Returns: 
Array.<string>
  Array of CSS class names applicable to the control.
code »
getClassNamesForState(state) ⇒
?Array.<string>
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.
Arguments:
state :
number
Bit mask of component states.
Returns: 
?Array.<string>
  Array of CSS class names representing the given state (null if none).
code »
getContentElement(element) ⇒
?Element
Takes the control's root element and returns the parent element of the control's contents. Since by default controls are rendered as a single DIV, the default implementation returns the element itself. Subclasses with more complex DOM structures must override this method as needed.
Arguments:
element :
?Element
Root element of the control whose content element is to be returned.
Returns: 
?Element
  The control's content element.
code »
getCssClass() ⇒
string
Returns the CSS class name to be applied to the root element of all components rendered or decorated using this renderer. The class name is expected to uniquely identify the renderer class, i.e. no two renderer classes are expected to share the same CSS class name.
Returns: 
string
  Renderer-specific CSS class name.
code »
getIe6ClassCombinations() ⇒
Array.<Array.<string>>
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 contasnt instead.
Returns: 
Array.<Array.<string>>
  Array of class name combinations.
code »
getKeyEventTarget(control) ⇒
Element
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.
Arguments:
control :
goog.ui.Control
Control whose key event target is to be returned.
Returns: 
Element
  The key event target.
code »
getStateFromClass(className) ⇒
goog.ui.Component.State
Takes a single CSS class name which may represent a component state, and returns the corresponding component state (0x00 if none).
Arguments:
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).
code »
getStructuralCssClass() ⇒
string
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).
code »
initializeDom(control)
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}.
Arguments:
control :
goog.ui.Control
Control whose DOM is to be initialized as it enters the document.
code »
isFocusable(control) ⇒
boolean
Returns true if the control's key event target supports keyboard focus (based on its {@code tabIndex} attribute), false otherwise.
Arguments:
control :
goog.ui.Control
Control whose key event target is to be checked.
Returns: 
boolean
  Whether the control's key event target is focusable.
code »
setAllowTextSelection(element, allow)
Allows or disallows text selection within the control's DOM.
Arguments:
element :
Element
The control's root element.
allow :
boolean
Whether the element should allow text selection.
code »
setAriaRole(element)
Sets the element's ARIA role on browsers that support it.
Arguments:
element :
Element
Element to update.
code »
setContent(element, content)
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.
Arguments:
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.
code »
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.
Arguments:
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.
code »
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.
Arguments:
element :
Element
The control's root element.
rightToLeft :
boolean
Whether the component is rendered right-to-left.
code »
setState(control, state, enable)
Updates the appearance of the control in response to a state change.
Arguments:
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.
code »
setVisible(element, visible)
Shows or hides the element.
Arguments:
element :
Element
Element to update.
visible :
boolean
Whether to show the element.
code »
updateAriaState(element, state, enable)
Updates the element's ARIA (accessibility) state on Gecko.
Arguments:
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.
code »

Static Methods

goog.ui.ControlRenderer.getCustomRenderer(ctor, cssClassName) ⇒
goog.ui.ControlRenderer
Constructs a new renderer and sets the CSS class that the renderer will use as the base CSS class to apply to all elements rendered by that renderer. An example to use this function using a color palette: 
var myCustomRenderer = goog.ui.ControlRenderer.getCustomRenderer(
goog.ui.PaletteRenderer, 'my-special-palette');
var newColorPalette = new goog.ui.ColorPalette(
colors, myCustomRenderer, opt_domHelper);
Your CSS can look like this now: 
.my-special-palette { }
.my-special-palette-table { }
.my-special-palette-cell { }
etc.
instead of 
.CSS_MY_SPECIAL_PALETTE .goog-palette { }
.CSS_MY_SPECIAL_PALETTE .goog-palette-table { }
.CSS_MY_SPECIAL_PALETTE .goog-palette-cell { }
etc.
You would want to use this functionality when you want an instance of a component to have specific styles different than the other components of the same type in your application. This avoids using descendant selectors to apply the specific styles to this component.
Arguments:
ctor :
Function
The constructor of the renderer you are trying to create.
cssClassName :
string
The name of the CSS class for this renderer.
Returns: 
goog.ui.ControlRenderer
  An instance of the desired renderer with its getCssClass() method overridden to return the supplied custom CSS class name.
code »

Static Properties

goog.ui.ControlRenderer.CSS_CLASS :
string
Default CSS class to be applied to the root element of components rendered by this renderer.
Code »
goog.ui.ControlRenderer.IE6_CLASS_COMBINATIONS :
Array.<Array.<string>>
Array of arrays of CSS classes that we want composite classes added and removed for in IE6 and lower as a workaround for lack of multi-class CSS selector support. Subclasses that have accompanying CSS requiring this workaround should define their own static IE6_CLASS_COMBINATIONS constant and override getIe6ClassCombinations to return it. For example, if your stylesheet uses the selector .button.collapse-left (and is compiled to .button_collapse-left for the IE6 version of the stylesheet,) you should include ['button', 'collapse-left'] in this array and the class button_collapse-left will be applied to the root element whenever both button and collapse-left are applied individually. Members of each class name combination will be joined with underscores in the order that they're defined in the array. You should alphabetize them (for compatibility with the CSS compiler) unless you are doing something special.
Code »

Package ui

Package Reference