goog.ui.PaletteRenderer

Provided By	`goog.ui.PaletteRenderer`
Extends	`goog.ui.ControlRenderer`
All Known Direct Subclasses	`goog.ui.emoji.EmojiPaletteRenderer`

Default renderer for goog.ui.Palettes. Renders the palette as an HTML table wrapped in a DIV, with one palette item per cell:

<div class="goog-palette">
  <table class="goog-palette-table">
    <tbody class="goog-palette-body">
      <tr class="goog-palette-row">
        <td class="goog-palette-cell">...Item 0...</td>
        <td class="goog-palette-cell">...Item 1...</td>
        ...
      </tr>
      <tr class="goog-palette-row">
        ...
      </tr>
    </tbody>
  </table>
</div>

new PaletteRenderer()

Parameters	None.

VIEW SOURCE

Instance Methods

Overrides goog.ui.ControlRenderer#canDecorate to always return false.

Overrides

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	Ignored.

Returns

boolean

False, since palettes don't support the decorate flow (for now).

VIEW SOURCE

Returns a table cell element (or equivalent) that wraps the given palette item (which must be a DOM node).

Parameters

`node`	`(Node\|string\|null)`
	Palette item.
`dom`	`(goog.dom.DomHelper\|null)`
	DOM helper for document interaction.

Returns

Element

Cell element.

VIEW SOURCE

Returns the palette items arranged in a table wrapped in a DIV, with the renderer's own CSS class and additional state-specific classes applied to it.

Overrides

goog.ui.ControlRenderer

Parameters

`palette`	`(goog.ui.Control\|null)`
	goog.ui.Palette to render.

Returns

Element

Root element for the palette.

VIEW SOURCE

Returns the given items in a table with size.width columns and size.height rows. If the table is too big, empty cells will be created as needed. If the table is too small, the items that don't fit will not be rendered.

Parameters

`items`	`(Array<(Node\|null)>\|null)`
	Palette items.
`size`	`(goog.math.Size\|null)`
	Palette size (columns x rows); both dimensions must be specified as numbers.
`dom`	`(goog.dom.DomHelper\|null)`
	DOM helper for document interaction.

Returns

Element

Palette table element.

VIEW SOURCE

Returns a table row element (or equivalent) that wraps the given cells.

Parameters

`cells`	`(Array<(Element\|null)>\|null)`
	Array of cell elements.
`dom`	`(goog.dom.DomHelper\|null)`
	DOM helper for document interaction.

Returns

Element

Row element.

VIEW SOURCE

Returns a table element (or equivalent) that wraps the given rows.

Parameters

`rows`	`(Array<(Element\|null)>\|null)`
	Array of row elements.
`dom`	`(goog.dom.DomHelper\|null)`
	DOM helper for document interaction.

Returns

Element

Palette table element.

VIEW SOURCE

Overrides goog.ui.ControlRenderer#decorate to be a no-op, since palettes don't support the decorate flow (for now).

Overrides

goog.ui.ControlRenderer

Parameters

`palette`	`(goog.ui.Control\|null)`
	Ignored.
`element`	`(Element\|null)`
	Ignored.

Returns

null

Always null.

VIEW SOURCE

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.

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|Element\|null)`
	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.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	Control to be updated.
`className`	`string`
	CSS class name to add or remove.
`enable`	`boolean`
	Whether to add or remove the class name.

VIEW SOURCE

Returns the ARIA role to be applied to the control. See http://wiki/Main/ARIA for more info.

Defined by

goog.ui.ControlRenderer

Parameters

None.

Returns

(goog.a11y.aria.Role|undefined)

ARIA role.

VIEW SOURCE

Parameters

`node`	`(Node\|null)`
	Item whose cell is to be returned.

Returns

(Element|null)

The grid cell for the palette item.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

`state`	`goog.ui.Component.State`
	Component state.

Returns

(string|undefined)

CSS class representing the given state (undefined if none).

VIEW SOURCE

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 #getCssClass, followed by
the structural CSS class returned by getStructuralCssClass (if different from the renderer-specific CSS class), followed by
any state-specific classes returned by #getClassNamesForState, followed by
any extra classes returned by the control's `getExtraClassNames` method and
for IE6 and lower, additional combined classes from 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.

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	Control whose CSS classes are to be returned.

Returns

Array<string>

Array of CSS class names applicable to the control.

VIEW SOURCE

Takes a bit mask of goog.ui.Component.States, 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 getClassForState method to generate each state-specific class.

Defined by

goog.ui.ControlRenderer

Parameters

`state`	`number`
	Bit mask of component states.

Returns

Array<string>

Array of CSS class names representing the given state.

VIEW SOURCE

Returns the item corresponding to the given node, or null if the node is neither a palette cell nor part of a palette item.

Parameters

`palette`	`(goog.ui.Palette\|null)`
	Palette in which to look for the item.
`node`	`(Node\|null)`
	Node to look for.

Returns

(Node|null)

The corresponding palette item (null if not found).

VIEW SOURCE

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.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	Root element of the control whose content element is to be returned.

Returns

(Element|null)

The control's content element.

VIEW SOURCE

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

Overrides

goog.ui.ControlRenderer

Parameters

None.

Returns

string

Renderer-specific CSS class.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

None.

Returns

Array<(Array<string>|null)>

Array of class name combinations.

VIEW SOURCE

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.

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	Control whose key event target is to be returned.

Returns

(Element|null)

The key event target.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

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

VIEW SOURCE

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 #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 #getCssClass, but subclasses are expected to override this method as needed.

Defined by

goog.ui.ControlRenderer

Parameters

None.

Returns

string

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

VIEW SOURCE

Updates the highlight styling of the palette cell containing the given node based on the value of the Boolean argument.

Parameters

`palette`	`(goog.ui.Palette\|null)`
	Palette containing the item.
`node`	`(Node\|null)`
	Item whose cell is to be highlighted or un-highlighted.
`highlight`	`boolean`
	If true, the cell is highlighted; otherwise it is un-highlighted.

VIEW SOURCE

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 goog.ui.Control#enterDocument.

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	Control whose DOM is to be initialized as it enters the document.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	Control whose key event target is to be checked.

Returns

boolean

Whether the control's key event target is focusable.

VIEW SOURCE

Updates the selection styling of the palette cell containing the given node based on the value of the Boolean argument.

Parameters

`palette`	`(goog.ui.Palette\|null)`
	Palette containing the item.
`node`	`(Node\|null)`
	Item whose cell is to be selected or deselected.
`select`	`boolean`
	If true, the cell is selected; otherwise it is deselected.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	The control's root element.
`allow`	`boolean`
	Whether the element should allow text selection.

VIEW SOURCE

Sets the element's ARIA label. This should be overriden by subclasses that don't apply the role directly on control.element_.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`Element`
	Element whose ARIA label is to be updated.
`ariaLabel`	`string`
	Label to add to the element.

VIEW SOURCE

Sets the element's ARIA role.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	Element to update.
`opt_preferredRole`	`(goog.a11y.aria.Role\|null)=`
	The preferred ARIA role.

VIEW SOURCE

Sets the element's ARIA attributes, including distinguishing between universally supported ARIA properties and ARIA states that are only supported by certain ARIA roles. Only attributes which are initialized to be true will be set.

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`goog.ui.Control`
	Control whose ARIA state will be updated.
`element`	`Element`
	Element whose ARIA state is to be updated.

VIEW SOURCE

Overrides goog.ui.ControlRenderer#setContent for palettes. Locates the HTML table representing the palette grid, and replaces the contents of each cell with a new element from the array of nodes passed as the second argument. If the new content has too many items the table will have more rows added to fit, if there are less items than the table has cells, then the left over cells will be empty.

Overrides

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	Root element of the palette control.
`content`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Array of items to replace existing palette items.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	Control whose key event target is to be updated.
`focusable`	`boolean`
	Whether to enable keyboard focus support on the control's key event target.

VIEW SOURCE

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.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	The control's root element.
`rightToLeft`	`boolean`
	Whether the component is rendered right-to-left.

VIEW SOURCE

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

Defined by

goog.ui.ControlRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	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.

VIEW SOURCE

Shows or hides the element.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	Element to update.
`visible`	`boolean`
	Whether to show the element.

VIEW SOURCE

Updates the element's ARIA (accessibility) attributes , including distinguishing between universally supported ARIA properties and ARIA states that are only supported by certain ARIA roles.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	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.

VIEW SOURCE

Static Functions

Parameters

None.

Returns

goog.ui.PaletteRenderer

VIEW SOURCE

Static Properties

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

VIEW SOURCE

Data attribute to store grid width from palette control.

VIEW SOURCE

goog.ui.PaletteRenderer

new PaletteRenderer()

Instance Methods

this.canDecorate( element ) → boolean

this.createCell( node, dom ) → Element

this.createDom( palette ) → Element

this.createGrid( items, size, dom ) → Element

this.createRow( cells, dom ) → Element

this.createTable( rows, dom ) → Element

this.decorate( palette, element ) → null

this.enableClassName( control, className, enable ) → void

this.enableExtraClassName( control, className, enable ) → void

this.getAriaRole() → (goog.a11y.aria.Role|undefined)

this.getCellForItem( node ) → (Element|null)

this.getClassForState( state ) → (string|undefined)

this.getClassNames( control ) → Array<string>

this.getClassNamesForState( state ) → Array<string>

this.getContainingItem( palette, node ) → (Node|null)

this.getContentElement( element ) → (Element|null)

this.getCssClass() → string

this.getIe6ClassCombinations() → Array<(Array<string>|null)>

this.getKeyEventTarget( control ) → (Element|null)

this.getStateFromClass( className ) → goog.ui.Component.State

this.getStructuralCssClass() → string

this.highlightCell( palette, node, highlight ) → void

this.initializeDom( control ) → void

this.isFocusable( control ) → boolean

this.selectCell( palette, node, select ) → void

this.setAllowTextSelection( element, allow ) → void

this.setAriaLabel( element, ariaLabel ) → void

this.setAriaRole( element, opt_preferredRole ) → void

this.setAriaStates( control, element ) → void

this.setContent( element, content ) → void

this.setFocusable( control, focusable ) → void

this.setRightToLeft( element, rightToLeft ) → void

this.setState( control, state, enable ) → void

this.setVisible( element, visible ) → void

this.updateAriaState( element, state, enable ) → void

Static Functions

PaletteRenderer.getInstance() → goog.ui.PaletteRenderer

Static Properties

PaletteRenderer.CSS_CLASS → string

PaletteRenderer.GRID_WIDTH_ATTRIBUTE → string

`this.`canDecorate( `element` ) `→` `boolean`

`this.`createCell( `node`, `dom` ) `→` `Element`

`this.`createDom( `palette` ) `→` `Element`

`this.`createGrid( `items`, `size`, `dom` ) `→` `Element`

`this.`createRow( `cells`, `dom` ) `→` `Element`

`this.`createTable( `rows`, `dom` ) `→` `Element`

`this.`decorate( `palette`, `element` ) `→` `null`

`this.`enableClassName( `control`, `className`, `enable` ) `→` `void`

`this.`enableExtraClassName( `control`, `className`, `enable` ) `→` `void`

`this.`getAriaRole() `→` `(goog.a11y.aria.Role|undefined)`

`this.`getCellForItem( `node` ) `→` `(Element|null)`

`this.`getClassForState( `state` ) `→` `(string|undefined)`

`this.`getClassNames( `control` ) `→` `Array<string>`

`this.`getClassNamesForState( `state` ) `→` `Array<string>`

`this.`getContainingItem( `palette`, `node` ) `→` `(Node|null)`

`this.`getContentElement( `element` ) `→` `(Element|null)`

`this.`getCssClass() `→` `string`

`this.`getIe6ClassCombinations() `→` `Array<(Array<string>|null)>`

`this.`getKeyEventTarget( `control` ) `→` `(Element|null)`

`this.`getStateFromClass( `className` ) `→` `goog.ui.Component.State`

`this.`getStructuralCssClass() `→` `string`

`this.`highlightCell( `palette`, `node`, `highlight` ) `→` `void`

`this.`initializeDom( `control` ) `→` `void`

`this.`isFocusable( `control` ) `→` `boolean`

`this.`selectCell( `palette`, `node`, `select` ) `→` `void`

`this.`setAllowTextSelection( `element`, `allow` ) `→` `void`

`this.`setAriaLabel( `element`, `ariaLabel` ) `→` `void`

`this.`setAriaRole( `element`, `opt_preferredRole` ) `→` `void`

`this.`setAriaStates( `control`, `element` ) `→` `void`

`this.`setContent( `element`, `content` ) `→` `void`

`this.`setFocusable( `control`, `focusable` ) `→` `void`

`this.`setRightToLeft( `element`, `rightToLeft` ) `→` `void`

`this.`setState( `control`, `state`, `enable` ) `→` `void`

`this.`setVisible( `element`, `visible` ) `→` `void`

`this.`updateAriaState( `element`, `state`, `enable` ) `→` `void`

PaletteRenderer.getInstance() `→` `goog.ui.PaletteRenderer`

PaletteRenderer.CSS_CLASS `→` `string`

PaletteRenderer.GRID_WIDTH_ATTRIBUTE `→` `string`