goog.ui.Checkbox

Adds the specified component as the last child of this component. See goog.ui.Component#addChildAt for detailed semantics.

Defined by	goog.ui.Component
Parameters	child (goog.ui.Component|null) The new child component. opt_render boolean= If true, the child component will be rendered into the parent.
See Also	goog.ui.Component#addChildAt

Adds the specified component as a child of this component at the given 0-based index.

Both addChild and addChildAt assume the following contract between parent and child components:

• the child component's element must be a descendant of the parent component's element, and
• the DOM state of the child component must be consistent with the DOM state of the parent component (see `isInDocument`) in the steady state -- the exception is to addChildAt(child, i, false) and then immediately decorate/render the child.

In particular, parent.addChild(child) will throw an error if the child component is already in the document, but the parent isn't.

Clients of this API may call addChild and addChildAt with opt_render set to true. If opt_render is true, calling these methods will automatically render the child component's element into the parent component's element. If the parent does not yet have an element, then createDom will automatically be invoked on the parent before rendering the child.

Invoking parent.addChild(child, true) will throw an error if the child component is already in the document, regardless of the parent's DOM state.

If opt_render is true and the parent component is not already in the document, enterDocument will not be called on this component at this point.

Finally, this method also throws an error if the new child already has a different parent, or the given index is out of bounds.

Defined by	goog.ui.Component
Parameters	child (goog.ui.Component|null) The new child component. index number 0-based index at which the new child component is to be added; must be between 0 and the current child count (inclusive). opt_render boolean= If true, the child component will be rendered into the parent.
Returns	Nada.
See Also	goog.ui.Component#addChild

Adds the given class name to the list of classes to be applied to the component's root element.

Defined by	goog.ui.Control
Parameters	className string Additional class name to be applied to the component's root element.

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.

warning Deprecated	Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler.

Defined by

goog.events.EventTarget

Parameters

type (string|goog.events.EventId) The type of the event to listen for handler (function(?): ?|{handleEvent: function(?): ?}|null) The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument. opt_capture boolean= In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event. opt_handlerScope (Object|null)= Object in whose scope to call the listener.

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Defined by	goog.Disposable
Parameters	callback function(): ? The callback function. opt_scope (T|null)= An optional scope to call the callback in.

Returns true if the given element can be decorated by this component. Overrides goog.ui.Component#canDecorate.

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	element (Element|null) Element to decorate.
Returns	boolean Whether the element can be decorated by this component.

Creates the control's DOM. Overrides goog.ui.Component#createDom by delegating DOM manipulation to the control's renderer.

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	None.

Decorates the element for the UI component. If the element is in the document, the enterDocument method will be called.

If goog.ui.Component.ALLOW_DETACHED_DECORATION is false, the caller must pass an element that is in the document.

Defined by	goog.ui.Component
Parameters	element (Element|null) Element to decorate.

Decorates the given element with this component. Overrides goog.ui.Component#decorateInternal by delegating DOM manipulation to the control's renderer.

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	element (Element|null) Element to decorate.

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object.

If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	e (string|Object|null) Event object.
Returns	boolean If anyone called preventDefault on the event object (or if any of the listeners returns false) this will also return false.

Disposes of the object and its resources.

Overrides	goog.Disposable
Specified by	goog.disposable.IDisposable
Parameters	None.
Returns	Nothing.

Disposes of the component. Calls exitDocument, which is expected to remove event handlers and clean up the component. Propagates the call to the component's children, if any. Removes the component's DOM from the document unless it was decorated.

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	None.

Adds or removes the given class name to/from the list of classes to be applied to the component's root element.

Defined by	goog.ui.Control
Parameters	className string CSS class name to add or remove. enable boolean Whether to add or remove the class name.

Configures the component after its DOM has been rendered, and sets up event handling. Overrides goog.ui.Component#enterDocument.

Overrides	goog.ui.Control
Parameters	None.

Cleans up the component before its DOM is removed from the document, and removes event handlers. Overrides goog.ui.Component#exitDocument by making sure that components that are removed from the document aren't focusable (i.e. have no tab index).

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	None.

Fires all registered listeners in this listenable for the given type and capture mode, passing them the given eventObject. This does not perform actual capture/bubble. Only implementors of the interface should be using this.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	type (string|goog.events.EventId<(EVENTOBJ|null)>) The type of the listeners to fire. capture boolean The capture mode of the listeners to fire. eventObject (EVENTOBJ|null) The event object to fire.
Returns	boolean Whether all listeners succeeded without attempting to prevent default behavior. If any listener returns false or called goog.events.Event#preventDefault, this returns false.

Calls the given function on each of this component's children in order. If opt_obj is provided, it will be used as the 'this' object in the function when called. The function should take two arguments: the child component and its 0-based index. The return value is ignored.

Defined by	goog.ui.Component
Parameters	f function(?, number): ? The function to call for every child component; should take 2 arguments (the child and its index). opt_obj (T|null)= Used as the 'this' object in f when called.

Gets the control's aria label.

Defined by	goog.ui.Control
Parameters	None.
Returns	(string|null) This control's aria label.

Returns the child with the given ID, or null if no such child exists.

Defined by	goog.ui.Component
Parameters	id string Child component ID.
Returns	(goog.ui.Component|null) The child with the given ID; null if none.

Returns the child at the given index, or null if the index is out of bounds.

Defined by	goog.ui.Component
Parameters	index number 0-based index.
Returns	(goog.ui.Component|null) The child at the given index; null if none.

Returns the number of children of this component.

Defined by	goog.ui.Component
Parameters	None.
Returns	number The number of children.

Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.

Defined by	goog.ui.Component
Parameters	None.
Returns	Array<string> Child component IDs.

Returns the text caption or DOM structure displayed in the component.

Defined by	goog.ui.Control
Parameters	None.
Returns	(string|Node|Array<Node>|NodeList<Node>|null) Text caption or DOM structure comprising the component's contents.

Returns the DOM element into which child components are to be rendered, or null if the control itself hasn't been rendered yet. Overrides goog.ui.Component#getContentElement by delegating to the renderer.

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	None.
Returns	(Element|null) Element to contain child elements (null if none).

Returns the dom helper that is being used on this component.

Defined by	goog.ui.Component
Parameters	None.
Returns	goog.dom.DomHelper The dom helper used on this component.

Gets the component's element.

Defined by	goog.ui.Component
Parameters	None.
Returns	(Element|null) The element for the component.

Returns the first element in this component's DOM with the provided className.

Defined by	goog.ui.Component
Parameters	className string The name of the class to look for.
Returns	(Element|null) The first item with the class name provided.

Helper function for returning an element in the document with a unique id generated using makeId().

Defined by	goog.ui.Component
Parameters	idFragment string The partial id.
Returns	(Element|null) The element with the unique id, or null if it cannot be found.

Gets the component's element. This differs from getElement in that it assumes that the element exists (i.e. the component has been rendered/decorated) and will cause an assertion error otherwise (if assertion is enabled).

Defined by	goog.ui.Component
Parameters	None.
Returns	Element The element for the component.

Returns an array of all the elements in this component's DOM with the provided className.

Defined by	goog.ui.Component
Parameters	className string The name of the class to look for.
Returns	IArrayLike<Element> The items found with the class name provided.

Returns any additional class name(s) to be applied to the component's root element, or null if no extra class names are needed.

Defined by	goog.ui.Control
Parameters	None.
Returns	(Array<string>|null) Additional class names to be applied to the component's root element (null if none).

Helper function for returning the fragment portion of an id generated using makeId().

Defined by	goog.ui.Component
Parameters	id string Id generated with makeId().
Returns	string Fragment.

Returns the event handler for this component, lazily created the first time this method is called.

Defined by	goog.ui.Component
Parameters	None.
Returns	goog.events.EventHandler<(T|null)> Event handler for this component.

Gets the unique ID for the instance of this component. If the instance doesn't already have an ID, generates one on the fly.

Defined by	goog.ui.Component
Parameters	None.
Returns	string Unique component ID.

Returns the DOM element on which the control is listening for keyboard events (null if none).

Defined by	goog.ui.Control
Parameters	None.
Returns	(Element|null) Element on which the control is listening for key events.

Returns the keyboard event handler for this component, lazily created the first time this method is called. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	None.
Returns	goog.events.KeyHandler Keyboard event handler for this component.

Gets the goog.events.ListenableKey for the event or null if no such listener is in use.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	type (string|goog.events.EventId<(EVENTOBJ|null)>) The name of the event without the 'on' prefix. listener function((EVENTOBJ|null)): (boolean|undefined) The listener function to get. capture boolean Whether the listener is a capturing listener. opt_listenerScope (SCOPE|null)= Object in whose scope to call the listener.
Returns	(goog.events.ListenableKey|null) the found listener or null if not found.

Gets all listeners in this listenable for the given type and capture mode.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	type (string|goog.events.EventId) The type of the listeners to fire. capture boolean The capture mode of the listeners to fire.
Returns	Array<goog.events.ListenableKey> An array of registered listeners.

Returns the model associated with the UI component.

Defined by	goog.ui.Component
Parameters	None.
Returns	* The model.

Returns the component's parent, if any.

Defined by	goog.ui.Component
Parameters	None.
Returns	(goog.ui.Component|null) The parent component.

Returns the parent of this event target to use for capture/bubble mechanism.

NOTE(chrishenry): The name reflects the original implementation of custom event target (goog.events.EventTarget). We decided that changing the name is not worth it.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	None.
Returns	(goog.events.Listenable|null) The parent EventTarget or null if there is no parent.

Returns the control's preferred ARIA role. This can be used by a control to override the role that would be assigned by the renderer. This is useful in cases where a different ARIA role is appropriate for a control because of the context in which it's used. E.g., a goog.ui.MenuButton added to a goog.ui.Select should have an ARIA role of LISTBOX and not MENUITEM.

Defined by	goog.ui.Control
Parameters	None.
Returns	(goog.a11y.aria.Role|null) This control's preferred ARIA role or null if no preferred ARIA role is set.

Returns the renderer used by this component to render itself or to decorate an existing element.

Defined by	goog.ui.Control
Parameters	None.
Returns	(goog.ui.ControlRenderer|null|undefined) Renderer used by the component (undefined if none).

Similar to getElementByClass except that it expects the element to be present in the dom thus returning a required value. Otherwise, will assert.

Defined by	goog.ui.Component
Parameters	className string The name of the class to look for.
Returns	Element The first item with the class name provided.

Returns the component's state as a bit mask of goog.ui.Component.States.

Defined by	goog.ui.Control
Parameters	None.
Returns	number Bit mask representing component state.

Handles blur events on the component's key event target element. Always deactivates the component. In addition, if the component is focusable, updates its state and styling to indicate that it no longer has keyboard focus. Considered protected; should only be used within this package and by subclasses. Warning: IE dispatches focus and blur events asynchronously!

Defined by	goog.ui.Control
Parameters	e (goog.events.Event|null) Blur event to handle.

Handles contextmenu events.

Defined by	goog.ui.Control
Parameters	e (goog.events.BrowserEvent|null) Event to handle.

Handles dblclick events. Should only be registered if the user agent is IE. If the component is enabled, performs its associated action by calling performActionInternal. This is used to allow more performant buttons in IE. In IE, no mousedown event is fired when that mousedown will trigger a dblclick event. Because of this, a user clicking quickly will only cause ACTION events to fire on every other click. This is a workaround to generate ACTION events for every click. Unfortunately, this workaround won't ever trigger the ACTIVE state. This is roughly the same behaviour as if this were a 'button' element with a listener on mouseup. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.Event|null) Mouse event to handle.

Handles focus events on the component's key event target element. If the component is focusable, updates its state and styling to indicate that it now has keyboard focus. Considered protected; should only be used within this package and by subclasses. Warning: IE dispatches focus and blur events asynchronously!

Defined by	goog.ui.Control
Parameters	e (goog.events.Event|null) Focus event to handle.

Attempts to handle a keyboard event, if the component is enabled and visible, by calling handleKeyEventInternal. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.KeyEvent|null) Key event to handle.
Returns	boolean Whether the key event was handled.

Attempts to handle a keyboard event; returns true if the event was handled, false otherwise. Considered protected; should only be used within this package and by subclasses.

Overrides	goog.ui.Control
Parameters	e (goog.events.KeyEvent|null) Key event to handle.
Returns	boolean Whether the key event was handled.

Handles mousedown events. If the component is enabled, highlights and activates it. If the component isn't configured for keyboard access, prevents it from receiving keyboard focus. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.Event|null) Mouse event to handle.

Handles mouseout events. Dispatches a LEAVE event; if the event isn't canceled, and the component supports auto-highlighting, deactivates and un-highlights the component. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.BrowserEvent|null) Mouse event to handle.

Handles mouseover events. Dispatches an ENTER event; if the event isn't canceled, the component is enabled, and it supports auto-highlighting, highlights the component. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.BrowserEvent|null) Mouse event to handle.

Handles mouseup events. If the component is enabled, highlights it. If the component has previously been activated, performs its associated action by calling performActionInternal, then deactivates it. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.Event|null) Mouse event to handle.

Returns true if the component has children.

Defined by	goog.ui.Component
Parameters	None.
Returns	boolean True if the component has children.

Whether there is any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	opt_type (string|goog.events.EventId<(EVENTOBJ|null)>)= Event type. opt_capture boolean= Whether to check for capture or bubble listeners.
Returns	boolean Whether there is any active listeners matching the requested type and/or capture phase.

Returns true if the component is in the specified state, false otherwise.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to check.
Returns	boolean Whether the component is in the given state.

Returns the 0-based index of the given child component, or -1 if no such child is found.

Defined by	goog.ui.Component
Parameters	child (goog.ui.Component|null) The child component.
Returns	number 0-based index of the child component; -1 if not found.

Returns true if the component is active (pressed), false otherwise.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is active.

Returns true if the control allows text selection within its DOM, false otherwise. Controls that disallow text selection have the appropriate unselectable styling applied to their elements. Note that controls hosted in containers will report that they allow text selection even if their container disallows text selection.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the control allows text selection.

Returns true if the component provides default event handling for the state, false otherwise.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to check.
Returns	boolean Whether the component provides default event handling for the state.

Returns true if the component is checked, false otherwise.

Overrides	goog.ui.Control
Parameters	None.
Returns	boolean Whether the checkbox is checked.

Returns true if the component is set to dispatch transition events for the given state, false otherwise.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to check.
Returns	boolean Whether the component dispatches transition events for the state.

Returns true if the component is enabled, false otherwise.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is enabled.

Returns true if the component is styled to indicate that it has keyboard focus, false otherwise. Note that isFocused() returning true doesn't guarantee that the component's key event target has keyboard focus, only that it is styled as such.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is styled to indicate as having keyboard focus.

Returns true if the control is configured to handle its own mouse events, false otherwise. Controls not hosted in goog.ui.Containers have to handle their own mouse events, but controls hosted in containers may allow their parent to handle mouse events on their behalf. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the control handles its own mouse events.

Returns true if the component is currently highlighted, false otherwise.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is highlighted.

Determines whether the component has been added to the document.

Defined by	goog.ui.Component
Parameters	None.
Returns	boolean TRUE if rendered. Otherwise, FALSE.

Returns true if the component is open (expanded), false otherwise.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is open.

Returns true if the component is rendered right-to-left, false otherwise. The first time this function is invoked, the right-to-left rendering property is set if it has not been already.

Defined by	goog.ui.Component
Parameters	None.
Returns	boolean Whether the control is rendered right-to-left.

Returns true if the component is selected, false otherwise.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is selected.

Returns true if the component supports the specified state, false otherwise.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to check.
Returns	boolean Whether the component supports the given state.

Returns true if the transition into or out of the given state is allowed to proceed, false otherwise. A state transition is allowed under the following conditions:

• the component supports the state,
• the component isn't already in the target state,
• either the component is configured not to dispatch events for this state transition, or a transition event was dispatched and wasn't canceled by any event listener, and
• the component hasn't been disposed of

Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to/from which the control is transitioning. enable boolean Whether the control is entering or leaving the state.
Returns	boolean Whether the state transition is allowed to proceed.

Returns true if the component's visibility is set to visible, false if it is set to hidden. A component that is set to hidden is guaranteed to be hidden from the user, but the reverse isn't necessarily true. A component may be set to visible but can otherwise be obscured by another element, rendered off-screen, or hidden using direct CSS manipulation.

Defined by	goog.ui.Control
Parameters	None.
Returns	boolean Whether the component is visible.

Adds an event listener. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	type (string|goog.events.EventId<(EVENTOBJ|null)>) The event type id. listener function((EVENTOBJ|null)): (boolean|undefined) Callback method. opt_useCapture boolean= Whether to fire in capture phase (defaults to false). opt_listenerScope (SCOPE|null)= Object in whose scope to call the listener.
Returns	goog.events.ListenableKey Unique key for the listener.

Adds an event listener that is removed automatically after the listener fired once.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	type (string|goog.events.EventId<(EVENTOBJ|null)>) The event type id. listener function((EVENTOBJ|null)): (boolean|undefined) Callback method. opt_useCapture boolean= Whether to fire in capture phase (defaults to false). opt_listenerScope (SCOPE|null)= Object in whose scope to call the listener.
Returns	goog.events.ListenableKey Unique key for the listener.

Helper function for subclasses that gets a unique id for a given fragment, this can be used by components to generate unique string ids for DOM elements.

Defined by	goog.ui.Component
Parameters	idFragment string A partial id.
Returns	string Unique element id.

Makes a collection of ids. This is a convenience method for makeId. The object's values are the id fragments and the new values are the generated ids. The key will remain the same.

Defined by	goog.ui.Component
Parameters	object (Object|null) The object that will be used to create the ids.
Returns	Object<string, string> An object of id keys to generated ids.

Performs the appropriate action when the control is activated by the user. The default implementation first updates the checked and selected state of controls that support them, then dispatches an ACTION event. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	e (goog.events.Event|null) Event that triggered the action.
Returns	boolean Whether the action is allowed to proceed.

Returns whether this component should listen for PointerEvent types rather than MouseEvent types. This allows supporting drag gestures for touch/stylus input.

Defined by	goog.ui.Component
Parameters	None.
Returns	boolean

Associates a disposable object with this object so that they will be disposed together.

Defined by	goog.Disposable
Parameters	disposable (goog.disposable.IDisposable|null) that will be disposed when this object is disposed.

Removes all listeners from this listenable. If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	opt_type (string|goog.events.EventId)= Type of event to remove, default is to remove all types.
Returns	number Number of listeners removed.

Removes the given child from this component, and returns it. Throws an error if the argument is invalid or if the specified child isn't found in the parent component. The argument can either be a string (interpreted as the ID of the child component to remove) or the child component itself.

If opt_unrender is true, calls goog.ui.component#exitDocument on the removed child, and subsequently detaches the child's DOM from the document. Otherwise it is the caller's responsibility to clean up the child component's DOM.

Defined by	goog.ui.Component
Parameters	child (string|goog.ui.Component|null) The ID of the child to remove, or the child component itself. opt_unrender boolean= If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns	(goog.ui.Component|null) The removed component, if any.
See Also	goog.ui.Component#removeChildAt

Removes the child at the given index from this component, and returns it. Throws an error if the argument is out of bounds, or if the specified child isn't found in the parent. See goog.ui.Component#removeChild for detailed semantics.

Defined by	goog.ui.Component
Parameters	index number 0-based index of the child to remove. opt_unrender boolean= If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns	(goog.ui.Component|null) The removed component, if any.
See Also	goog.ui.Component#removeChild

Removes every child component attached to this one and returns them.

Defined by	goog.ui.Component
Parameters	opt_unrender boolean= If true, calls #exitDocument on the removed child components, and detaches their DOM from the document.
Returns	Array<(goog.ui.Component|null)> The removed components if any.
See Also	goog.ui.Component#removeChild

Removes the given class name from the list of classes to be applied to the component's root element.

Defined by	goog.ui.Control
Parameters	className string Class name to be removed from the component's root element.

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

warning Deprecated	Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler.

Defined by

goog.events.EventTarget

Parameters

type (string|goog.events.EventId) The type of the event to listen for handler (function(?): ?|{handleEvent: function(?): ?}|null) The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument. opt_capture boolean= In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event. opt_handlerScope (Object|null)= Object in whose scope to call the listener.

Renders the component. If a parent element is supplied, the component's element will be appended to it. If there is no optional parent element and the element doesn't have a parentNode then it will be appended to the document body.

If this component has a parent component, and the parent component is not in the document already, then this will not call enterDocument on this component.

Throws an Error if the component is already rendered.

Defined by	goog.ui.Component
Parameters	opt_parentElement (Element|null)= Optional parent element to render the component into.

Renders the component before another element. The other element should be in the document already.

Throws an Error if the component is already rendered.

Defined by	goog.ui.Component
Parameters	sibling (Node|null) Node to render the component before.

Activates or deactivates the component. Does nothing if this state transition is disallowed.

Defined by	goog.ui.Control
Parameters	active boolean Whether to activate or deactivate the component.
See Also	#isTransitionAllowed

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

Defined by	goog.ui.Control
Parameters	allow boolean Whether the control should allow text selection.

Sets the control's aria label. This can be used to assign aria label to the element after it is rendered.

Defined by	goog.ui.Control
Parameters	label string The string to set as the aria label for this control. No escaping is done on this value.

Enables or disables automatic event handling for the given state(s).

Defined by	goog.ui.Control
Parameters	states number Bit mask of goog.ui.Component.States for which default event handling is to be enabled or disabled. enable boolean Whether the component should provide default event handling for the state(s).

Sets the text caption of the component.

Defined by	goog.ui.Control
Parameters	caption string Text caption of the component.

Sets the checked state of the checkbox.

Overrides	goog.ui.Control
Parameters	checked (boolean|null) The checked state to set.

Sets the checked state for the checkbox. Unlike #setChecked, doesn't update the checkbox's DOM. Considered protected; to be called only by renderer code during element decoration.

Parameters	checked goog.ui.Checkbox.State New checkbox state.

Sets the component's content to the given text caption, element, or array of nodes. (If the argument is an array of nodes, it must be an actual array, not an array-like object.)

Defined by	goog.ui.Control
Parameters	content (string|Node|Array<Node>|NodeList<Node>|null) Text caption or DOM structure to set as the component's contents.

Sets the component's content to the given text caption, element, or array of nodes. Unlike #setContent, doesn't modify the component's DOM. Called by renderers during element decoration.

This should only be used by subclasses and its associated renderers.

Defined by	goog.ui.Control
Parameters	content (string|Node|Array<Node>|NodeList<Node>|null) Text caption or DOM structure to set as the component's contents.

Enables or disables transition events for the given state(s). Controls handle state transitions internally by default, and only dispatch state transition events if explicitly requested to do so by calling this method.

Defined by	goog.ui.Control
Parameters	states number Bit mask of goog.ui.Component.States for which transition events should be enabled or disabled. enable boolean Whether transition events should be enabled.

Sets the component's root element to the given element. Considered protected and final.

This should generally only be called during createDom. Setting the element does not actually change which element is rendered, only the element that is associated with this UI component.

This should only be used by subclasses and its associated renderers.

Defined by	goog.ui.Component
Parameters	element (Element|null) Root element for the component.

Enables or disables the component. Does nothing if this state transition is disallowed. If the component is both visible and focusable, updates its focused state and tab index as needed. If the component is being disabled, ensures that it is also deactivated and un-highlighted first. Note that the component's enabled/disabled state is "locked" as long as it is hosted in a goog.ui.Container that is itself disabled; this is to prevent clients from accidentally re-enabling a control that is in a disabled container.

Defined by	goog.ui.Control
Parameters	enable boolean Whether to enable or disable the component.
See Also	#isTransitionAllowed

Applies or removes styling indicating that the component has keyboard focus. Note that unlike the other "set" methods, this method is called as a result of the component's element having received or lost keyboard focus, not the other way around, so calling setFocused(true) doesn't guarantee that the component's key event target has keyboard focus, only that it is styled as such.

Defined by	goog.ui.Control
Parameters	focused boolean Whether to apply or remove styling to indicate that the component's element has keyboard focus.

Enables or disables mouse event handling for the control. Containers may use this method to disable mouse event handling in their child controls. Considered protected; should only be used within this package and by subclasses.

Defined by	goog.ui.Control
Parameters	enable boolean Whether to enable or disable mouse event handling.

Highlights or unhighlights the component. Does nothing if this state transition is disallowed.

Defined by	goog.ui.Control
Parameters	highlight boolean Whether to highlight or unhighlight the component.
See Also	#isTransitionAllowed

Assigns an ID to this component instance. It is the caller's responsibility to guarantee that the ID is unique. If the component is a child of a parent component, then the parent component's child index is updated to reflect the new ID; this may throw an error if the parent already has a child with an ID that conflicts with the new ID.

Defined by	goog.ui.Component
Parameters	id string Unique component ID.

Binds an HTML element to the checkbox which if clicked toggles the checkbox. Behaves the same way as the 'label' HTML tag. The label element has to be the direct or non-direct ancestor of the checkbox element because it will get the focus when keyboard support is implemented. Note: Control#enterDocument also sets aria-label on the element but Checkbox#enterDocument sets aria-labeledby on the same element which overrides the aria-label in all modern screen readers.

Parameters	label (Element|null) The label control to set. If null, only the checkbox reacts to clicks.

Sets the model associated with the UI component.

Defined by	goog.ui.Component
Parameters	obj * The model.

Opens (expands) or closes (collapses) the component. Does nothing if this state transition is disallowed.

Defined by	goog.ui.Control
Parameters	open boolean Whether to open or close the component.
See Also	#isTransitionAllowed

Sets the parent of this component to use for event bubbling. Throws an error if the component already has a parent or if an attempt is made to add a component to itself as a child. Callers must use removeChild or removeChildAt to remove components from their containers before calling this method.

Defined by	goog.ui.Component
Parameters	parent (goog.ui.Component|null) The parent component.
See Also	goog.ui.Component#removeChild goog.ui.Component#removeChildAt

Overrides goog.events.EventTarget#setParentEventTarget to throw an error if the parent component is set, and the argument is not the parent.

Defined by	goog.ui.Component
Overrides	goog.events.EventTarget
Parameters	parent (goog.events.EventTarget|null) Parent listenable (null if none).

Indicates whether this component should listen for PointerEvent types rather than MouseEvent types. This allows supporting drag gestures for touch/stylus input. Must be called before enterDocument to listen for the correct event types.

Defined by	goog.ui.Component
Parameters	enable boolean

Sets the control's preferred ARIA role. This can be used to override the role that would be assigned by the renderer. This is useful in cases where a different ARIA role is appropriate for a control because of the context in which it's used. E.g., a goog.ui.MenuButton added to a goog.ui.Select should have an ARIA role of LISTBOX and not MENUITEM.

Defined by	goog.ui.Control
Parameters	role goog.a11y.aria.Role This control's preferred ARIA role.

Registers the given renderer with the component. Changing renderers after the component has entered the document is an error.

Defined by	goog.ui.Control
Parameters	renderer (goog.ui.ControlRenderer|null) Renderer used by the component.
Throws	{Error} If the control is already in the document.

Set is right-to-left. This function should be used if the component needs to know the rendering direction during dom creation (i.e. before #enterDocument is called and is right-to-left is set).

Defined by	goog.ui.Control
Overrides	goog.ui.Component
Parameters	rightToLeft boolean Whether the component is rendered right-to-left.

Selects or unselects the component. Does nothing if this state transition is disallowed.

Defined by	goog.ui.Control
Parameters	select boolean Whether to select or unselect the component.
See Also	#isTransitionAllowed

Sets or clears the given state on the component, and updates its styling accordingly. Does nothing if the component is already in the correct state or if it doesn't support the specified state. Doesn't dispatch any state transition events; use advisedly.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to set or clear. enable boolean Whether to set or clear the state (if supported). opt_calledFrom boolean= Prevents looping with setEnabled.

Sets the component's state to the state represented by a bit mask of goog.ui.Component.States. Unlike #setState, doesn't update the component's styling, and doesn't reject unsupported states. Called by renderers during element decoration. Considered protected; should only be used within this package and by subclasses.

This should only be used by subclasses and its associated renderers.

Defined by	goog.ui.Control
Parameters	state number Bit mask representing component state.

Enables or disables support for the given state. Disabling support for a state while the component is in that state is an error.

Defined by	goog.ui.Control
Parameters	state goog.ui.Component.State State to support or de-support. support boolean Whether the component should support the state.
Throws	{Error} If disabling support for a state the control is currently in.

Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.

Defined by	goog.events.EventTarget
Parameters	target Object The target.

Shows or hides the component. Does nothing if the component already has the requested visibility. Otherwise, dispatches a SHOW or HIDE event as appropriate, giving listeners a chance to prevent the visibility change. When showing a component that is both enabled and focusable, ensures that its key target has a tab index. When hiding a component that is enabled and focusable, blurs its key target and removes its tab index.

Defined by	goog.ui.Control
Parameters	visible boolean Whether to show or hide the component. opt_force boolean= If true, doesn't check whether the component already has the requested visibility, and doesn't dispatch any events.
Returns	boolean Whether the visibility was changed.

Toggles the checkbox. State transitions:

• unchecked -> checked
• undetermined -> checked
• checked -> unchecked

Removes an event listener which was added with listen() or listenOnce().

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	type (string|goog.events.EventId<(EVENTOBJ|null)>) The event type id. listener function((EVENTOBJ|null)): (boolean|undefined) Callback method. opt_useCapture boolean= Whether to fire in capture phase (defaults to false). opt_listenerScope (SCOPE|null)= Object in whose scope to call the listener.
Returns	boolean Whether any listener was removed.

Removes an event listener which was added with listen() by the key returned by listen().

Overrides	goog.events.EventTarget
Specified by	goog.events.Listenable
Parameters	key goog.events.ListenableKey The key returned by listen() or listenOnce().
Returns	boolean Whether any listener was removed.

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

DomHelper used to interact with the document, allowing components to be created in a different window.