The goog.ui.equation.MenuPaletteRenderer Class

goog.ui.equation.MenuPaletteRenderer
> goog.ui.equation.PaletteRenderer
> goog.ui.PaletteRenderer
> goog.ui.ControlRenderer

The renderer for menu palette.

.canDecorate(element)

Inherited from goog.ui.PaletteRenderer .

Overrides {@link goog.ui.ControlRenderer#canDecorate} to always return false.

element {Element}
Ignored.
returns {boolean}
False, since palettes don't support the decorate flow (for now).

.createCell(node, dom)

Inherited from goog.ui.PaletteRenderer .

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

node {Node|string}
Palette item.
dom {goog.dom.DomHelper}
DOM helper for document interaction.
returns {Element}
Cell element.

.createDom(palette)

Inherited from goog.ui.PaletteRenderer .

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.

palette {goog.ui.Control}
goog.ui.Palette to render.
returns {Element}
Root element for the palette.

.createGrid(items, size, dom)

Inherited from goog.ui.PaletteRenderer .

Returns the given items in a table with {@code size.width} columns and {@code 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.

items {Array.<Node>}
Palette items.
size {goog.math.Size}
Palette size (columns x rows); both dimensions must be specified as numbers.
dom {goog.dom.DomHelper}
DOM helper for document interaction.
returns {Element}
Palette table element.

.createRow(cells, dom)

Inherited from goog.ui.PaletteRenderer .

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

cells {Array.<Element>}
Array of cell elements.
dom {goog.dom.DomHelper}
DOM helper for document interaction.
returns {Element}
Row element.

.createTable(rows, dom)

Inherited from goog.ui.PaletteRenderer .

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

rows {Array.<Element>}
Array of row elements.
dom {goog.dom.DomHelper}
DOM helper for document interaction.
returns {Element}
Palette table element.

.decorate(palette, element)

Inherited from goog.ui.PaletteRenderer .

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

palette {goog.ui.Control}
Ignored.
element {Element}
Ignored.
returns {null}
Always null.
@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()

Inherited from goog.ui.ControlRenderer .

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.

.getContainingItem(palette, node)

Inherited from goog.ui.PaletteRenderer .

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

palette {goog.ui.Palette}
Palette in which to look for the item.
node {Node}
Node to look for.
returns {Node}
The corresponding palette item (null if not found).

.getContentElement(element)

Inherited from goog.ui.ControlRenderer .

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.

element {Element}
Root element of the control whose content element is to be returned.
returns {Element}
The control's content element.

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

.getItemCssClass()

Inherited from goog.ui.equation.PaletteRenderer .

Returns the CSS class name for the palette item.

returns {string}
The CSS class name of the palette item.

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

.highlightCell(palette, node, highlight)

Inherited from goog.ui.PaletteRenderer .

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

palette {goog.ui.Palette}
Palette containing the item.
node {Node}
Item whose cell is to be highlighted or un-highlighted.
highlight {boolean}
If true, the cell is highlighted; otherwise it is un-highlighted.

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

.selectCell(palette, node, select)

Inherited from goog.ui.PaletteRenderer .

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

palette {goog.ui.Palette}
Palette containing the item.
node {Node}
Item whose cell is to be selected or deselected.
select {boolean}
If true, the cell is selected; otherwise it is deselected.

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

Overrides {@link 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.

element {Element}
Root element of the palette control.
content {goog.ui.ControlContent}
Array of items to replace existing palette items.

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

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