goog.ui.SubMenuRenderer

Provided By	`goog.ui.SubMenuRenderer`
Extends	`goog.ui.MenuItemRenderer` `goog.ui.ControlRenderer`

Default renderer for goog.ui.SubMenus. Each item has the following structure:

<div class="goog-submenu">
  ...(menuitem content)...
  <div class="goog-menu">
    ... (submenu content) ...
  </div>
</div>

new SubMenuRenderer()

Parameters	None.

VIEW SOURCE

Instance Methods

Returns true if this renderer can decorate the element, false otherwise. The default implementation always returns true.

Defined by

goog.ui.ControlRenderer

Parameters

`element`	`(Element\|null)`
	Element to decorate.

Returns

boolean

Whether the renderer can decorate the element.

VIEW SOURCE

Wraps the given text caption or existing DOM node(s) in a structural element containing the menu item's contents.

Defined by

goog.ui.MenuItemRenderer

Parameters

`content`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Menu item contents.
`dom`	`(goog.dom.DomHelper\|null)`
	DOM helper for document interaction.

Returns

Element

Menu item content element.

VIEW SOURCE

Overrides goog.ui.MenuItemRenderer#createDom by adding the additional class 'goog-submenu' to the created element, and passes the element to goog.ui.SubMenuItemRenderer#addArrow_ to add an child element that can be styled to show an arrow.

Overrides

goog.ui.MenuItemRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	goog.ui.SubMenu to render.

Returns

Element

Root element for the item.

VIEW SOURCE

Overrides goog.ui.MenuItemRenderer#decorate by adding the additional class 'goog-submenu' to the decorated element, and passing the element to goog.ui.SubMenuItemRenderer#addArrow_ to add a child element that can be styled to show an arrow. Also searches the element for a child with the class goog-menu. If a matching child element is found, creates a goog.ui.Menu, uses it to decorate the child element, and passes that menu to subMenu.setMenu.

Overrides

goog.ui.MenuItemRenderer

Parameters

`control`	`(goog.ui.Control\|null)`
	goog.ui.SubMenu to render.
`element`	`(Element\|null)`
	Element to decorate.

Returns

Element

Root element for the item.

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

Overrides

goog.ui.ControlRenderer

Parameters

None.

Returns

(goog.a11y.aria.Role|undefined)

ARIA role.

VIEW SOURCE

Takes a single goog.ui.Component.State, and returns the corresponding CSS class name (null if none). Overrides the superclass implementation by using 'highlight' as opposed to 'hover' as the CSS class name suffix for the HOVER state, for backwards compatibility.

Defined by

goog.ui.MenuItemRenderer

Overrides

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

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

Overrides

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

Defined by

goog.ui.MenuItemRenderer

Overrides

goog.ui.ControlRenderer

Parameters

None.

Returns

string

Renderer-specific CSS class name.

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). Overrides the superclass implementation by treating 'goog-option-selected' as special, for backwards compatibility.

Defined by

goog.ui.MenuItemRenderer

Overrides

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

Determines whether the item contains a checkbox element.

Defined by

goog.ui.MenuItemRenderer

Parameters

`element`	`(Element\|null)`
	Menu item root element.

Returns

boolean

Whether the element contains a checkbox element.

VIEW SOURCE

Returns true if the element appears to have a proper menu item structure by checking whether its first child has the appropriate structural class name.

Defined by

goog.ui.MenuItemRenderer

Parameters

`element`	`(Element\|null)`
	Element to check.

Returns

boolean

Whether the element appears to have a proper menu item DOM.

VIEW SOURCE

Overrides goog.ui.MenuItemRenderer#initializeDom to tweak the DOM structure for the span.goog-submenu-arrow element depending on the text direction (LTR or RTL). When the SubMenu is RTL the arrow will be given the additional class of goog-submenu-arrow-rtl, and the arrow will be moved up to be the first child in the SubMenu's element. Otherwise the arrow will have the class goog-submenu-arrow-ltr, and be kept as the last child of the SubMenu's element.

Overrides

goog.ui.ControlRenderer

Parameters

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

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

Enables/disables checkbox semantics on the menu item.

Defined by

goog.ui.MenuItemRenderer

Parameters

`item`	`(goog.ui.Control\|null)`
	Menu item to update.
`element`	`(Element\|null)`
	Menu item element to update (may be null if the item hasn't been rendered yet).
`checkable`	`boolean`
	Whether the item should be checkable.

VIEW SOURCE

Takes a menu item's root element, and sets its content to the given text caption or DOM structure. Overrides the superclass immplementation by making sure that the submenu arrow structure is preserved.

Overrides

goog.ui.MenuItemRenderer

Parameters

`element`	`(Element\|null)`
	The item's root element.
`content`	`(string\|Node\|Array<Node>\|NodeList<Node>\|null)`
	Text caption or DOM structure to be set as the item's content.

VIEW SOURCE

Adds or removes extra markup and CSS styling to the menu item to make it selectable or non-selectable, depending on the value of the selectable argument.

Defined by

goog.ui.MenuItemRenderer

Parameters

`item`	`goog.ui.Control`
	Menu item to update.
`element`	`Element`
	Menu item element to update.
`enable`	`boolean`
	Whether to add or remove the checkbox structure.

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

Enables/disables radio button semantics on the menu item.

Defined by

goog.ui.MenuItemRenderer

Parameters

`item`	`(goog.ui.Control\|null)`
	Menu item to update.
`element`	`(Element\|null)`
	Menu item element to update (may be null if the item hasn't been rendered yet).
`selectable`	`boolean`
	Whether the item should be selectable.

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

VIEW SOURCE

Static Properties

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

VIEW SOURCE

goog.ui.SubMenuRenderer

new SubMenuRenderer()

Instance Methods

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

`this.`createContent( `content`, `dom` ) `→` `Element`

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

`this.`decorate( `control`, `element` ) `→` `Element`

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

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

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

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

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

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

`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.`hasCheckBoxStructure( `element` ) `→` `boolean`

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

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

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

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

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

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

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

`this.`setCheckable( `item`, `element`, `checkable` ) `→` `void`

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

`this.`setEnableCheckBoxStructure( `item`, `element`, `enable` ) `→` `void`

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

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

`this.`setSelectable( `item`, `element`, `selectable` ) `→` `void`

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

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

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

Static Functions

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

Static Properties

SubMenuRenderer.CSS_CLASS `→` `string`

goog.ui.SubMenuRenderer

new SubMenuRenderer()

Instance Methods

this.canDecorate( element ) → boolean

this.createContent( content, dom ) → Element

this.createDom( control ) → Element

this.decorate( control, element ) → Element

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

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

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

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

this.getClassNames( control ) → Array<string>

this.getClassNamesForState( state ) → Array<string>

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.hasCheckBoxStructure( element ) → boolean

this.hasContentStructure( element ) → boolean

this.initializeDom( control ) → void

this.isFocusable( control ) → boolean

this.setAllowTextSelection( element, allow ) → void

this.setAriaLabel( element, ariaLabel ) → void

this.setAriaRole( element, opt_preferredRole ) → void

this.setAriaStates( control, element ) → void

this.setCheckable( item, element, checkable ) → void

this.setContent( element, content ) → void

this.setEnableCheckBoxStructure( item, element, enable ) → void

this.setFocusable( control, focusable ) → void

this.setRightToLeft( element, rightToLeft ) → void

this.setSelectable( item, element, selectable ) → void

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

this.setVisible( element, visible ) → void

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

Static Functions

SubMenuRenderer.getInstance() → goog.ui.SubMenuRenderer

Static Properties

SubMenuRenderer.CSS_CLASS → string

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

`this.`createContent( `content`, `dom` ) `→` `Element`

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

`this.`decorate( `control`, `element` ) `→` `Element`

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

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

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

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

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

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

`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.`hasCheckBoxStructure( `element` ) `→` `boolean`

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

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

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

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

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

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

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

`this.`setCheckable( `item`, `element`, `checkable` ) `→` `void`

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

`this.`setEnableCheckBoxStructure( `item`, `element`, `enable` ) `→` `void`

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

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

`this.`setSelectable( `item`, `element`, `selectable` ) `→` `void`

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

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

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

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

SubMenuRenderer.CSS_CLASS `→` `string`