UIZE JavaScript Framework

MODULES Uize.Web

1. Introduction

The Uize.Web module provides support for ease of selecting, traversing, styling, and wiring events of DOM nodes, among other useful operations needed for creating an interactive UI.

DEVELOPERS: Ben Ilegbodu, original code contributed by Zazzle Inc.

1.1. Not a Uize Subclass

First off, it's worth emphasizing that the Uize.Web object is not a Uize.Class subclass, but a very lightweight object.

As such, the Uize.Web object does not support events, does not provide state properties, does not inherit subclassing facilities from the Uize.Class base class, etc. This object is deliberately designed to be very lightweight and to have a really tiny footprint - in the spirit of JavaScript's native objects, such as String, Number, Date, and the like.

1.2. Key Features

The Uize.Web object provides the following key features...

1.2.1. Selectors

document...

1.2.2. Method Chaining

document...

1.2.3. Dynamic Methods Return Values

document...

1.2.4. Method Overloading

document...

1.2.5. CSS Methods

document...

1.2.5.1. CSS Support

document...

1.2.6. Events-Related Methods

document...

1.2.6.1. Virtual Event Methods

document...

1.2.7. Node Info/Manipulation Methods

document...

1.2.8. Display-Related Methods

document...

1.2.9. Filtering & Traversing Methods

Filtering & traversing functionality is provided via the Uize.Web.xFilters extension module. Pages that want to leverage the syntax-friendly nature of Uize.Web may not need to leverage any filtering or traversing functionality. Therefore, the filtering & traversing functionality is not implemented in the Uize.Web class in order to reduce the need for loading the extra code. Instead, in order to include the filtering & traversing functionality, one needs to require the Uize.Web.xFilters extension module.

1.2.10. DOM Manipulation Methods

document...

Additional DOM manipulation functionality is provided via the Uize.Web.xDom extension module. Pages that want to leverage the syntax-friendly nature of Uize.Web may not need to leverage any DOM manipulation. Therefore, the DOM manipulation functionality is not implemented in the Uize.Web class in order to reduce the need for loading the extra code. Instead, in order to include the DOM manipulation functionality, one needs to require the Uize.Web.xDom extension module.

1.2.11. Animation Methods

Animations & effects are provided via the Uize.Web.xEffects extension module. Pages that want to leverage the syntax-friendly nature of Uize.Web may not need to leverage any animation effects. Therefore, the animation effects functionality is not implemented in the Uize.Web class in order to reduce the need for loading the extra code. Instead, in order to include the animation effects, one needs to require the Uize.Web.xEffects extension module.

1.3. Creating Instances

document...

1.4. Extensions

The Uize.Web object module has the following extensions...

Uize.Web.xEffects - provides animation effects
Uize.Web.xFilters - provides filtering & traversing functionality
Uize.Web.xDom - provides DOM manipulation functionality

1.5. Examples

There are no dedicated showcase example pages for the Uize.Web module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Web module...

SEARCH

1.6. Implementation Info

The Uize.Web module defines the Uize.Web object under the Uize namespace.

1.6.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

INSTANCE METHODS

add | addClass | after | altClick | ancestors | ancestorsUntil | animate | any | append | appendTo | atEndOfConstructor | attribute | before | blur | change | children | clearQueue | click | closest | contained | contains | contentHeight | contentWidth | contents | coords | css | ctrlAltClick | ctrlClick | dblclick | delay | detach | dimensions | display | domReady | each | element | empty | error | fade | fadeIn | fadeOut | fadeTo | filter | find | first | focus | getClassState | getPrefixedProperty | handleGetAction | handleGetOrSetAction | handleSetAction | has | hasClass | height | hide | hover | html | index | innerHeight | innerWidth | insertAfter | insertBefore | invisible | keyRemainDown | keyRemainUp | keydown | keypress | keyup | last | load | map | mouseRemainDown | mouseRemainOut | mouseRemainOver | mouseRemainUp | mouseRest | mousedown | mousemove | mouseout | mouseover | mouseup | next | nextAll | nextUntil | not | offset | offsetParent | opacity | parent | prepend | prependTo | previous | previousAll | previousUntil | property | queue | remainBlurred | remainFocused | remove | removeAttribute | removeClass | removeClassState | replaceAll | replaceWith | resize | rotate | scroll | scrollHeight | scrollLeft | scrollTop | scrollWidth | select | setClassState | shiftAltClick | shiftClick | shiftCtrlAltClick | shiftCtrlClick | show | siblingIndex | siblings | single | slice | slideDown | slideIn | slideOut | slideUp | slideX | slideY | splice | stop | submit | supportsCss | text | toggleClass | toggleClassState | toggleFade | toggleShow | toggleSlideX | toggleSlideY | touchcancel | touchend | touchleave | touchmove | touchstart | transitionend | trigger | unload | unwire | value | visibility | visible | width | wire | wireOnce

STATIC METHODS

Uize.Web.getNodeUid | Uize.Web.getPrefixedProperty | Uize.Web.isMatch | Uize.Web.isWeb | Uize.Web.matches | Uize.Web.select | Uize.Web.selectCss | Uize.Web.supportsCss

STATIC PROPERTIES

Uize.Web.moduleName | Uize.Web.pathToResources | Uize.Web.supportsTouch

1.6.2. Features Overridden in This Module

No features have been overridden in this module.

1.6.3. Features Inherited From Other Modules

This module has no inherited features.

1.6.4. Modules Directly Under This Namespace

1.6.5. Unit Tests

There is no dedicated unit tests module for the Uize.Web module.

2. Constructor

Creates an instance of the Uize.Web object containing a collection of matched nodes found in the DOM based on the specified argument(s).

SYNTAX

webOBJ = Uize.Web(selectorSTR);

VARIATION 1

webOBJ = Uize.Web(selectorSTR, rootSelector);

VARIATION 2

webOBJ = Uize.Web(node);

VARIATION 3

webOBJ = Uize.Web(nodesARRAY);

VARIATION 4

webOBJ = Uize.Web(webOBJ);

VARIATION 5

webOBJ = Uize.Web();

3. Instance Properties

3.1. length

A number, reflecting of the number of nodes in the Uize.Web object.

NOTES

this is a read-only property

3.2. supportsTouch

A boolean, indicating whether or not the browser supports touch event.

NOTES

this is a read-only property
Some browsers may report that they do support touch even if there is not a touch interface.
See also Uize.Web.supportsTouch static property

4. Static Properties

4.1. Uize.Web.moduleName

IMPLEMENTATION INFO

this feature was introduced in this module

4.2. Uize.Web.pathToResources

IMPLEMENTATION INFO

this feature was introduced in this module

4.3. Uize.Web.supportsTouch

A boolean, indicating whether or not the browser supports touch event.

SYNTAX

supportsTouchBOOL = Uize.Web.supportsTouch;

NOTES

this is a read-only property
Some browsers may report that they do support touch even if there is not a touch interface.
See also supportsTouch instance property

IMPLEMENTATION INFO

this feature was introduced in this module

5. Static Methods

5.1. Uize.Web.getNodeUid

Gets a unique identifier for the specified node.

SYNTAX

nodeUidSTR = Uize.Web.matches(nodeOBJ);

NOTES

This is primarily for internal use by Uize.Web extensions

IMPLEMENTATION INFO

this feature was introduced in this module

5.2. Uize.Web.getPrefixedProperty

A method that returns the value of the specified (and potentially prefixed) property on the specified node object.

SYNTAX

propertyValueANYTYPE = Uize.Web.getPrefixedProperty(propertyNameSTR, nodeBLOB);

VARIATION 1

valueANYTYPE = Uize.Web.getPrefixedProperty(propertyNameSTR, nodeBLOB, returnKeyBOOL);

In this variation, the optional third returnKeyBOOL parameter indicates whether the return value should be the prefixed property name (when returnKeyBOOL is true) or the property value (when returnKeyBOOL is false).

VARIATION 2

propertyValueANYTYPE = Uize.Web.getPrefixedProperty(propertyNameSTR);

In this variation, when the nodeBLOB parameter is omitted, it is defaulted the document object.

NOTES

The default value of nodeBLOB is the document
The default value of returnKeyBOOL is false
Use this method instead of browser version testing to determine if a given property is supported by the browser
See also Uize.Web.supportsCss static method

IMPLEMENTATION INFO

this feature was introduced in this module

5.3. Uize.Web.isMatch

Returns whether or not the specified node matches the specified selector.

SYNTAX

isMatchBOOL = Uize.Web.isMatch(nodeBLOB, selectorSTR);

VARIATION 1

isMatchBOOL = Uize.Web.isMatch(nodeBLOB, nodeOBJ);

VARIATION 2

isMatchBOOL = Uize.Web.isMatch(nodeBLOB, webOBJ);

VARIATION 2

isMatchBOOL = Uize.Web.isMatch(nodeBLOB, nodesARRAY);

NOTES

This is primarily for internal use by Uize.Web extensions

IMPLEMENTATION INFO

this feature was introduced in this module

5.4. Uize.Web.isWeb

Returns whether or not the specified parameter is a Uize.Web object.

SYNTAX

isWebBOOL = Uize.Web.isWeb(paramANYTYPE);

NOTES

This is primarily for internal use by Uize.Web extensions

IMPLEMENTATION INFO

this feature was introduced in this module

5.5. Uize.Web.matches

A method that returns whether or not a specified DOM node matches a specified selector.

SYNTAX

matchesBOOL = Uize.Web.matches(nodeBLOB, selectorSTR);

NOTES

This method wraps the matches method available on DOM elmenent nodes.

IMPLEMENTATION INFO

this feature was introduced in this module

5.6. Uize.Web.select

Gets selection info for the specified selector.

SYNTAX

nodesARRAY = Uize.Web.select(selectorSTR, rootNodeBLOB);

VARIATION 1

nodesARRAY = Uize.Web.select(selectorSTR, rootNodeBLOB);

VARIATION 2

nodesARRAY = Uize.Web.select(node);

VARIATION 3

nodesARRAY = Uize.Web.select(nodesARRAY);

VARIATION 4

nodesARRAY = Uize.Web.select(webOBJ);

VARIATION 5

nodesARRAY = Uize.Web.select();

NOTES

This is primarily for internal use by Uize.Web extensions

IMPLEMENTATION INFO

this feature was introduced in this module

5.7. Uize.Web.selectCss

A method that returns a list of nodes within the specified (optional) root DOM node (using depth-first pre-order traversal of the root node's child nodes) that match ths specified selector.

SYNTAX

nodesARRAY = Uize.Web.matches(selectorSTR, rootNodeBLOB);

VARIATION

nodesARRAY = Uize.Web.matches(selectorSTR);

NOTES

This method wraps the querySelectorAll method that applies to the document object and other DOM elements.
see also Constructor

IMPLEMENTATION INFO

this feature was introduced in this module

5.8. Uize.Web.supportsCss

A method that determines whether or not the specified CSS property is supported in the current browser.

SYNTAX

supportedSTR = Uize.Web.supportsCss(propertyNameSTR);

VARIATION

supportedSTR = Uize.Web.supportsCss(propertyNameSTR, nodeBLOB);

NOTES

Use this method instead of browser version testing to determine if a given CSS property is supported by the browser
See also supportsCss instance method

IMPLEMENTATION INFO

this feature was introduced in this module

6. Instance Methods

6.1. add

IMPLEMENTATION INFO

this feature was introduced in this module

6.2. addClass

Adds the specified class name(s) to each of the set of matched DOM nodes, provided the class name(s) is(are) not already present.

SYNTAX

myWeb = myWeb.addClass(classNameSTR);

VARIATION

myWeb = myWeb.addClass(classNameFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion removeClass method
See the related hasClass and toggleClass methods
See also the setClassState method
For more details see the addClass method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.3. after

IMPLEMENTATION INFO

this feature was introduced in this module

6.4. altClick

Wires the specified event handler to the "altClick" virtual event (the user clicks with only the alt modifier key pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.altClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion ctrlClick, ctrlAltClick, shiftClick, shiftAltClick, shiftCtrlClick and shiftCtrlAltClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.5. ancestors

IMPLEMENTATION INFO

this feature was introduced in this module

6.6. ancestorsUntil

IMPLEMENTATION INFO

this feature was introduced in this module

6.7. animate

IMPLEMENTATION INFO

this feature was introduced in this module

6.8. any

IMPLEMENTATION INFO

this feature was introduced in this module

6.9. append

IMPLEMENTATION INFO

this feature was introduced in this module

6.10. appendTo

IMPLEMENTATION INFO

this feature was introduced in this module

6.11. atEndOfConstructor

A hook method called at the end of the constructor.

SYNTAX

atEndOfConstructor();

NOTES

This is primarily for internal use by Uize.Web extensions

IMPLEMENTATION INFO

this feature was introduced in this module

6.12. attribute

6.12.1. get

Gets the value of one or more attributes with the specified attribute name for each of the set of matched DOM nodes.

SYNTAX

attributeSTR = myWeb.attribute(attributeNameSTR); // one matched node

VARIATION 1

attributesOBJ = myWeb.attribute(attributesARRAY); // one matched node

VARIATION 2

attributesARRAY = myWeb.attribute(attributeNameSTR, returnAllBOOL); // multiple matched nodes

VARIATION 3

attributesARRAY = myWeb.attribute(attributesARRAY, returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related property method

6.12.2. set

Sets one or more attributes for the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.attribute(attributeNameSTR, valueSTR);

VARIATION 1

myWeb = myWeb.attribute(attributesOBJ);

VARIATION 2

myWeb = myWeb.attribute(attributeNameSTR, valueFUNC);

NOTES

Returns a reference to the same Uize.Web object
See related property method
See related removeAttribute method

IMPLEMENTATION INFO

this feature was introduced in this module

6.13. before

IMPLEMENTATION INFO

this feature was introduced in this module

6.14. blur

6.14.1. wire

Wires the specified event handler to the "blur" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.blur(eventHandlerFUNC);

VARIATION

myWeb = myWeb.blur(eventHandlerFUNC, throttleINT);

6.14.2. trigger

Triggers a "blur" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.blur();

NOTES

Returns a reference to the same Uize.Web object
See the companion focus method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.15. change

6.15.1. wire

Wires the specified event handler to the "change" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.change(eventHandlerFUNC);

VARIATION

myWeb = myWeb.change(eventHandlerFUNC, throttleINT);

6.15.2. trigger

Triggers a "change" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.change();

NOTES

Returns a reference to the same Uize.Web object
See the companion select method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.16. children

IMPLEMENTATION INFO

this feature was introduced in this module

6.17. clearQueue

IMPLEMENTATION INFO

this feature was introduced in this module

6.18. click

6.18.1. wire

Wires the specified event handler to the "click" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.click(eventHandlerFUNC);

VARIATION

myWeb = myWeb.click(eventHandlerFUNC, throttleINT);

6.18.2. trigger

Triggers a "click" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.click();

NOTES

Returns a reference to the same Uize.Web object
See the companion dblclick method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.19. closest

IMPLEMENTATION INFO

this feature was introduced in this module

6.20. contained

IMPLEMENTATION INFO

this feature was introduced in this module

6.21. contains

IMPLEMENTATION INFO

this feature was introduced in this module

6.22. contentHeight

6.22.1. get

Gets the computed height for the set of matched DOM nodes, excluding padding, border and margin.

SYNTAX

heightINT = myWeb.contentHeight(); // one matched node

VARIATION

heightsARRAY = myWeb.contentHeight(returnAllBOOL); // multiple matched nodes

The difference between css('height') and contentHeight() is that the latter returns a unit-less pixel value (i.e. 400), while the former returns a value with the units (i.e. "20%").

Calling height() (as opposed to css('height')) is recommended when a DOM node's height needs to be used in a mathematical calculation.

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
Use height for retrieving height of the window object
Use document.body with contentHeight for the document object
See also related height method

6.22.2. set

Sets the CSS height for every node in the set of matched DOM nodes..

SYNTAX

myWeb = myWeb.contentHeight(heightINTorSTR);

VARIATION

myWeb = myWeb.contentHeight(heightFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.23. contentWidth

6.23.1. get

Gets the computed width for the set of matched DOM nodes, excluding padding, border and margin.

SYNTAX

widthINT = myWeb.contentWidth(); // one matched node

VARIATION

widthsARRAY = myWeb.contentWidth(returnAllBOOL); // multiple matched nodes

The difference between css('width') and contentWidth() is that the latter returns a unit-less pixel value (i.e. 400), while the former returns a value with the units (i.e. "20%").

Calling width() (as opposed to css('width')) is recommended when a DOM node's width needs to be used in a mathematical calculation.

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
Use width for retrieving height of the window object
Use document.body with contentWidth for the document object
See related width method

6.23.2. set

Sets the CSS width for every node in the set of matched DOM nodes..

SYNTAX

myWeb = myWeb.contentWidth(widthINTorSTR);

VARIATION

myWeb = myWeb.contentWidth(widthFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.24. contents

IMPLEMENTATION INFO

this feature was introduced in this module

6.25. coords

6.25.1. get

Gets the coordinates of the current set of matched DOM nodes, relative to the document.

SYNTAX

coordsOBJ = myWeb.coords(); // one matched node

VARIATION 1

coordsOBJ = myWeb.coords(windowRelativeBOOL); // one matched node

VARIATION 2

corodsARRAY = myWeb.coords(windowRelativeBOOL, returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related offset method

6.25.2. set

Sets the coordinates of every node in the set of matched DOM nodes, relative to the document.

SYNTAX

myWeb = myWeb.coords(coordinatesOBJ);

VARIATION 1

myWeb = myWeb.coords(coordinatesOBJ, windowRelativeBOOL);

VARIATION 2

myWeb = myWeb.coords(coordinatesFUNC);

VARIATION 3

myWeb = myWeb.coords(coordinatesFUNC, windowRelativeBOOL);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.26. css

6.26.1. get

Gets the value of one or more CSS properties for each of the set of matched DOM nodes.

SYNTAX

propertyValueSTR = myWeb.css(propertyNameSTR); // one matched node

VARIATION 1

propertyValuesOBJ = myWeb.css(propertyNamesARRAY); // one matched node

VARIATION 2

propretyValuesARRAY = myWeb.css(propertyNameSTR, returnAllBOOL); // multiple matched nodes

VARIATION 3

propretyValuesARRAY = myWeb.css(propertyNamesARRAY, returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

6.26.2. set

Sets one or more CSS properties for every node in the set of matched DOM nodes..

SYNTAX

myWeb = myWeb.css(propertyName, propertyValueSTR);

VARIATION 1

myWeb = myWeb.css(propertyName, propertyValueFUNC);

VARIATION 2

myWeb = myWeb.css(propertiesOBJ);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.27. ctrlAltClick

Wires the specified event handler to the "ctrlAltClick" virtual event (the user clicks with only the ctrl and alt modifier keys pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.ctrlAltClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion altClick, ctrlClick, shiftClick, shiftAltClick, shiftCtrlClick and shiftCtrlAltClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.28. ctrlClick

Wires the specified event handler to the "ctrlClick" virtual event (the user clicks with only the ctrl modifier key pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.ctrlClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion altClick, ctrlAltClick, shiftClick, shiftAltClick, shiftCtrlClick and shiftCtrlAltClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.29. dblclick

6.29.1. wire

Wires the specified event handler to the "dblclick" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.dblclick(eventHandlerFUNC);

VARIATION

myWeb = myWeb.dblclick(eventHandlerFUNC, throttleINT);

6.29.2. trigger

Triggers a "dblclick" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.dblclick();

NOTES

Returns a reference to the same Uize.Web object
See the companion click method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.30. delay

IMPLEMENTATION INFO

this feature was introduced in this module

6.31. detach

IMPLEMENTATION INFO

this feature was introduced in this module

6.32. dimensions

Gets the computed dimensions for the set of matched DOM nodes, including padding, border, and optionally margin.

SYNTAX

dimensionsOBJ = myWeb.dimensions(); // one matched node

VARIATION 1

dimensionsWithMarginsOBJ = myWeb.dimensions(includeMarginBOOL); // one matched node

VARIATION 2

dimensionsWithMarginsARRAY = myWeb.dimensions(includeMarginBOOL, returnAllBOOL); // multiple matched nodes

NOTES

Return values are integers (without 'px', 'em', etc.)
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

IMPLEMENTATION INFO

this feature was introduced in this module

6.33. display

Displays or hides each of the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.display(mustDisplayBOOL);

VARIATION

myWeb = myWeb.display();

NOTES

Returns a reference to the same Uize.Web object
See the companion show, hide and toggleShow methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.34. domReady

Wires the specified function to execute when the DOM is fully loaded.

SYNTAX

myWeb = myWeb.domReady(handlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
Wires the DOMContentLoaded event on the document

IMPLEMENTATION INFO

this feature was introduced in this module

6.35. each

Iterates over the set of matched DOM nodes, executing a function for each DOM node.

SYNTAX

myWeb = myWeb.each(iteratorFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.36. element

Retrieves the DOM node within the set of matched DOM nodes at the specified index.

SYNTAX

nodeOBJ = myWeb.element(indexINT);

VARIATION 1

noesARRAY = myWeb.element();

IMPLEMENTATION INFO

this feature was introduced in this module

6.37. empty

IMPLEMENTATION INFO

this feature was introduced in this module

6.38. error

Wires the specified event handler to the "error" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.error(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the related wire method

IMPLEMENTATION INFO

this feature was introduced in this module

6.39. fade

IMPLEMENTATION INFO

this feature was introduced in this module

6.40. fadeIn

IMPLEMENTATION INFO

this feature was introduced in this module

6.41. fadeOut

IMPLEMENTATION INFO

this feature was introduced in this module

6.42. fadeTo

IMPLEMENTATION INFO

this feature was introduced in this module

6.43. filter

IMPLEMENTATION INFO

this feature was introduced in this module

6.44. find

IMPLEMENTATION INFO

this feature was introduced in this module

6.45. first

IMPLEMENTATION INFO

this feature was introduced in this module

6.46. focus

6.46.1. wire

Wires the specified event handler to the "focus" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.focus(eventHandlerFUNC);

VARIATION

myWeb = myWeb.focus(eventHandlerFUNC, throttleINT);

6.46.2. trigger

Triggers a "focus" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.focus();

NOTES

Returns a reference to the same Uize.Web object
See the companion blur method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.47. getClassState

Returns a boolean or integer (a value of the type stateBOOLorINT), indicating the current state for the specified state classes for each of the set of matched DOM nodes.

SYNTAX

stateBOOLorINT = myWeb.getClassState(stateClassesSTRorARRAY); // first matched node

VARIATION

statesARRAY = myWeb.getClassState(stateClassesSTRorARRAY, returnAllBOOL); // all matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See the companion setClassState, toggleClassState, and removeClassState methods
For more details see the getState method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.48. getPrefixedProperty

Gets the value of the specified (and potentially prefixed) property in the current environment (i.e. browser) of the set of matched DOM nodes.

SYNTAX

propertyValueSTR = myWeb.getPrefixedProperty(propertyNameSTR); // one matched node

VARIATION

propertyValuesARRAY = myWeb.getPrefixedProperty(propertyNameSTR, returnAllBOOL); // multiple matched nodes

NOTES

Use this method instead of browser version testing to determine if a given property is supported by the browser
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See also Uize.Web.getPrefixedProperty static method

IMPLEMENTATION INFO

this feature was introduced in this module

6.49. handleGetAction

IMPLEMENTATION INFO

this feature was introduced in this module

6.50. handleGetOrSetAction

IMPLEMENTATION INFO

this feature was introduced in this module

6.51. handleSetAction

IMPLEMENTATION INFO

this feature was introduced in this module

6.52. has

IMPLEMENTATION INFO

this feature was introduced in this module

6.53. hasClass

Returns a boolean indicating whether or not any node within the set of matched DOM nodes contains the specified CSS class.

SYNTAX

hasClassBOOL = myWeb.hasClass(classNameSTR);

NOTES

See the related addClass, toggleClass, and removeClass methods
See also the getClassState method
For more details see the hasClass method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.54. height

Gets the computed height for the set of matched DOM nodes, including padding, border, and optionally margin.

SYNTAX

heightINT = myWeb.height(); // one matched node

VARIATION 1

heightWithMarginsINT = myWeb.height(includeMarginBOOL); // one matched node

VARIATION 2

heightWithMarginsARRAY = myWeb.height(includeMarginBOOL, returnAllBOOL); // multiple matched nodes

NOTES

Return values are integers (without 'px', 'em', etc.)
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

IMPLEMENTATION INFO

this feature was introduced in this module

6.55. hide

Hides each of the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.hide();

NOTES

Returns a reference to the same Uize.Web object
See the companion display and toggleShow methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.56. hover

Wires handlers to the set of matched DOM nodes, to be executed when the mouse pointer enters and leaves the DOM nodes.

SYNTAX

myWeb = myWeb.hover(handlerInFUNC, handlerOutFUNC);

VARIATION

myWeb = myWeb.hover(handlerInoUTFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.57. html

6.57.1. get

Gets the HTML contents for each of the set of matched DOM nodes.

SYNTAX

htmlSTR = myWeb.html(); // one matched node

VARIATION

htmlARRAY = myWeb.html(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

6.57.2. set

Sets the HTML of every node in the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.html(htmlSTR);

VARIATION

myWeb = myWeb.html(htmlFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.58. index

IMPLEMENTATION INFO

this feature was introduced in this module

6.59. innerHeight

Gets the computed height for the set of matched DOM nodes, including padding, but not border or margin.

SYNTAX

innerHeightINT = myWeb.innerHeight(); // one matched node

VARIATION

innerHeightARRAY = myWeb.innerHeight(returnAllBOOL); // multiple matched nodes

NOTES

Return values are integers (without 'px', 'em', etc.)
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

IMPLEMENTATION INFO

this feature was introduced in this module

6.60. innerWidth

Gets the computed width for the set of matched DOM nodes, including padding, but not border or margin.

SYNTAX

innerWidthINT = myWeb.innerWidth(); // one matched node

VARIATION

innerWidthARRAY = myWeb.innerWidth(returnAllBOOL); // multiple matched nodes

NOTES

Return values are integers (without 'px', 'em', etc.)
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

IMPLEMENTATION INFO

this feature was introduced in this module

6.61. insertAfter

IMPLEMENTATION INFO

this feature was introduced in this module

6.62. insertBefore

IMPLEMENTATION INFO

this feature was introduced in this module

6.63. invisible

Sets the visibility of each of the set of matched DOM nodes to invisible.

SYNTAX

myWeb = myWeb.invisible();

NOTES

Returns a reference to the same Uize.Web object
See the companion visible and visibility methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.64. keyRemainDown

Wires the specified event handler to the "keyRemainDown" virtual event (the user presses down on a key, and then holds down for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keyRemainDown(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.keyRemainDown(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion keyRemainUp method
See the related keydown method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.65. keyRemainUp

Wires the specified event handler to the "keyRemainUp" virtual event (the user releases a key, and then doesn't press down again for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keyRemainUp(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.keyRemainUp(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion keyRemainDown method
See the related keyup method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.66. keydown

6.66.1. wire

Wires the specified event handler to the "keydown" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keydown(eventHandlerFUNC);

VARIATION

myWeb = myWeb.keydown(eventHandlerFUNC, throttleINT);

6.66.2. trigger

Triggers a "keydown" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keydown();

NOTES

Returns a reference to the same Uize.Web object
See the companion keypress and keyup methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.67. keypress

6.67.1. wire

Wires the specified event handler to the "keypress" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keypress(eventHandlerFUNC);

VARIATION

myWeb = myWeb.keypress(eventHandlerFUNC, throttleINT);

6.67.2. trigger

Triggers a "keypress" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keypress();

NOTES

Returns a reference to the same Uize.Web object
See the companion keydown and keyup methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.68. keyup

6.68.1. wire

Wires the specified event handler to the "keyup" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keyup(eventHandlerFUNC);

VARIATION

myWeb = myWeb.keyup(eventHandlerFUNC, throttleINT);

6.68.2. trigger

Triggers a "keyup" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.keyup();

NOTES

Returns a reference to the same Uize.Web object
See the companion keydown and keypress methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.69. last

IMPLEMENTATION INFO

this feature was introduced in this module

6.70. load

Wires the specified event handler to the "load" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.load(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion unload method
See the related wire method

IMPLEMENTATION INFO

this feature was introduced in this module

6.71. map

IMPLEMENTATION INFO

this feature was introduced in this module

6.72. mouseRemainDown

Wires the specified event handler to the "mouseRemainDown" virtual event (the user moused down, and then doesn't mouse up or out for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseRemainDown(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.mouseRemainDown(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseRemainOut, mouseRemainOver, mouseRemainUp method
See the related mousedown method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.73. mouseRemainOut

Wires the specified event handler to the "mouseRemainOut" virtual event (the user moused out, and then doesn't mouse over for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseRemainOut(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.mouseRemainOut(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseRemainDown, mouseRemainOver, mouseRemainUp method
See the related mouseout method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.74. mouseRemainOver

Wires the specified event handler to the "mouseRemainOver" virtual event (the user moused over, and then doesn't mouse out or down for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseRemainOver(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.mouseRemainOver(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseRemainDown, mouseRemainOut, mouseRemainUp method
See the related mouseover method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.75. mouseRemainUp

Wires the specified event handler to the "mouseRemainUp" virtual event (the user moused up, and then doesn't mouse down for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseRemainUp(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.mouseRemainUp(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseRemainDown, mouseRemainOut, mouseRemainOver method
See the related mouseup method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.76. mouseRest

Wires the specified event handler to the "mouseRest" virtual event (the user moused over, and then doesn't mouse out or down for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseRest(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.mouseRest(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the related mouseRemainOver method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.77. mousedown

6.77.1. wire

Wires the specified event handler to the "mousedown" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mousedown(eventHandlerFUNC);

VARIATION

myWeb = myWeb.mousedown(eventHandlerFUNC, throttleINT);

6.77.2. trigger

Triggers a "mousedown" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mousedown();

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseup, mouseout, mousemove and mouseover methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.78. mousemove

6.78.1. wire

Wires the specified event handler to the "mousemove" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mousemove(eventHandlerFUNC);

VARIATION

myWeb = myWeb.mousemove(eventHandlerFUNC, throttleINT);

6.78.2. trigger

Triggers a "mousemove" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mousemove();

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseup, mouseout, mousedown and mouseover methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.79. mouseout

6.79.1. wire

Wires the specified event handler to the "mouseout" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseout(eventHandlerFUNC);

VARIATION

myWeb = myWeb.mouseout(eventHandlerFUNC, throttleINT);

6.79.2. trigger

Triggers a "mouseout" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseout();

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseup, mousemove, mousedown and mouseover methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.80. mouseover

6.80.1. wire

Wires the specified event handler to the "mouseover" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseover(eventHandlerFUNC);

VARIATION

myWeb = myWeb.mouseover(eventHandlerFUNC, throttleINT);

6.80.2. trigger

Triggers a "mouseover" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseover();

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseup, mousemove, mousedown and mouseout methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.81. mouseup

6.81.1. wire

Wires the specified event handler to the "mouseup" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseup(eventHandlerFUNC);

VARIATION

myWeb = myWeb.mouseup(eventHandlerFUNC, throttleINT);

6.81.2. trigger

Triggers a "mouseup" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.mouseup();

NOTES

Returns a reference to the same Uize.Web object
See the companion mouseout, mousemove, mousedown and mouseover methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.82. next

IMPLEMENTATION INFO

this feature was introduced in this module

6.83. nextAll

IMPLEMENTATION INFO

this feature was introduced in this module

6.84. nextUntil

IMPLEMENTATION INFO

this feature was introduced in this module

6.85. not

IMPLEMENTATION INFO

this feature was introduced in this module

6.86. offset

Gets the coordinates of the current set of matched DOM nodes, relative to the offset parent matching the (optional) selector.

SYNTAX

coordsOBJ = myWeb.offset(); // one matched node

VARIATION 1

coordsOBJ = myWeb.offset(selectorSTR); // one matched node

VARIATION 2

coordsOBJ = myWeb.offset(nodeOBJ); // one matched node

VARIATION 3

corodsARRAY = myWeb.offset(returnAllBOOL); // multiple matched nodes

VARIATION 4

corodsARRAY = myWeb.offset(selectorSTR, returnAllBOOL); // multiple matched nodes

VARIATION 5

corodsARRAY = myWeb.offset(nodeOBJ, returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related coords and offsetParent method

IMPLEMENTATION INFO

this feature was introduced in this module

6.87. offsetParent

For each of the set of matched DOM nodes, gets the closest ancestor DOM node that is positioned and matches the (optional) selector), wrapped a new Uize.Web object.

SYNTAX

newWeb = myWeb.offsetParent();

VARIATION 1

newWeb = myWeb.offsetParent(selectorSTR);

VARIATION 2

newWeb = myWeb.offsetParent(nodeOBJ);

NOTES

See related offset method

IMPLEMENTATION INFO

this feature was introduced in this module

6.88. opacity

6.88.1. get

Gets the opacity for the set of matched DOM nodes.

SYNTAX

opacityFLOAT = myWeb.opacity(); // one matched node

VARIATION

opacitiesARRAY = myWeb.opacity(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

6.88.2. set

Sets the CSS opacity for every node in the set of matched DOM nodes..

SYNTAX

myWeb = myWeb.opacity(opacityFLOAT);

VARIATION

myWeb = myWeb.opacity(opacityFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.89. parent

IMPLEMENTATION INFO

this feature was introduced in this module

6.90. prepend

IMPLEMENTATION INFO

this feature was introduced in this module

6.91. prependTo

IMPLEMENTATION INFO

this feature was introduced in this module

6.92. previous

IMPLEMENTATION INFO

this feature was introduced in this module

6.93. previousAll

IMPLEMENTATION INFO

this feature was introduced in this module

6.94. previousUntil

IMPLEMENTATION INFO

this feature was introduced in this module

6.95. property

6.95.1. get

Gets the value of one or more properties with the specified property name for each of the set of matched DOM nodes.

SYNTAX

propertySTR = myWeb.property(propertyNameSTR); // one matched node

VARIATION 1

propertiesOBJ = myWeb.property(propertiesARRAY); // one matched node

VARIATION 2

propertiesARRAY = myWeb.property(propertyNameSTR, returnAllBOOL); // multiple matched nodes

VARIATION 3

propertiesARRAY = myWeb.property(propertiesARRAY, returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related attribute method

6.95.2. set

Sets one or more property for the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.property(propertyNameSTR, valueSTR);

VARIATION 1

myWeb = myWeb.property(propertiesOBJ);

VARIATION 2

myWeb = myWeb.property(propertyNameSTR, valueFUNC);

NOTES

Returns a reference to the same Uize.Web object
See related attribute method

IMPLEMENTATION INFO

this feature was introduced in this module

6.96. queue

IMPLEMENTATION INFO

this feature was introduced in this module

6.97. remainBlurred

Wires the specified event handler to the "remainBlurred" virtual event (node loses focus and remains blurred / unfocused for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.remainBlurred(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.remainBlurred(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion remainFocused method
See the related blur method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.98. remainFocused

Wires the specified event handler to the "remainFocused" virtual event (node stays focused for a specified duration) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.remainFocused(eventHandlerFUNC, durationMsINT);

VARIATION

myWeb = myWeb.remainFocused(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion remainBlurred method
See the related focus method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.99. remove

IMPLEMENTATION INFO

this feature was introduced in this module

6.100. removeAttribute

Removes one or more attributes from each DOM node in the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.removeAttribute(attributeNameSTR);

VARIATION

myWeb = myWeb.removeAttribute(attributeNamesARRAY);

NOTES

Returns a reference to the same Uize.Web object
See also related attribute method

IMPLEMENTATION INFO

this feature was introduced in this module

6.101. removeClass

Removes the specified class name(s) from each of the set of matched DOM nodes, provided the class name(s) is(are) present.

SYNTAX

myWeb = myWeb.removeClass(classNameSTR);

VARIATION

myWeb = myWeb.removeClass(classNameFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion addClass method
See the related hasClass and toggleClass methods
See also the removeClassState method
For more details see the removeClass method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.102. removeClassState

Updates each of the set of matched DOM nodes to no longer contain one of the specified state classes.

SYNTAX

myWeb = myWeb.removeClassState(classNameSTR);

VARIATION

myWeb = myWeb.removeClassState(classNamesARRAY);

NOTES

Returns a reference to the same Uize.Web object
See the companion getClassState, setClassState and toggleClassState methods
For more details see the removeState method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.103. replaceAll

IMPLEMENTATION INFO

this feature was introduced in this module

6.104. replaceWith

IMPLEMENTATION INFO

this feature was introduced in this module

6.105. resize

6.105.1. wire

Wires the specified event handler to the "resize" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.resize(eventHandlerFUNC);

VARIATION

myWeb = myWeb.resize(eventHandlerFUNC, throttleINT);

6.105.2. trigger

Triggers a "resize" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.resize();

NOTES

Returns a reference to the same Uize.Web object
See the companion scroll method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.106. rotate

Sets the rotation angle for the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.rotate(rotationAngleINT);

VARIATION 1

myWeb = myWeb.rotate(rotationAngleSTR);

VARIATION 2

myWeb = myWeb.rotate(rotationAngleFUNC);

NOTES

Does not work in IE < 9
Abstracts the differences between how rotations are achieved in different browsers
Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.107. scroll

6.107.1. wire

Wires the specified event handler to the "scroll" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.scroll(eventHandlerFUNC);

VARIATION

myWeb = myWeb.scroll(eventHandlerFUNC, throttleINT);

6.107.2. trigger

Triggers a "scroll" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.scroll();

NOTES

Returns a reference to the same Uize.Web object
See the companion resize method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.108. scrollHeight

Gets the height of the scroll view for the set of matched DOM nodes, including padding, but not margin.

SYNTAX

scrollHeightINT = myWeb.scrollHeight();

VARIATION

scrollHeightINT = myWeb.scrollHeight(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related scrollTop, scrollLeft and scrollWidth methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.109. scrollLeft

6.109.1. get

Gets the horizontal position of the scroll bar for the set of matched DOM nodes.

SYNTAX

scrollLeftINT = myWeb.scrollLeft(); // one matched node

VARIATION

scrollLeftARRAY = myWeb.scrollLeft(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related scrollTop, scrollHeight and scrollWidth methods

6.109.2. set

Sets the horizontal position of the scroll bar for the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.scrollLeft(valueINT);

VARIATION

myWeb = myWeb.scrollLeft(valueFUNC);

NOTES

Returns a reference to the same Uize.Web object
See related scrollTop method

IMPLEMENTATION INFO

this feature was introduced in this module

6.110. scrollTop

6.110.1. get

Gets the vertical position of the scroll bar for each of the set of matched DOM nodes.

SYNTAX

scrollTopINT = myWeb.scrollTop(); // one matched node

VARIATION

scrollTopARRAY = myWeb.scrollTop(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related scrollLeft method

6.110.2. set

Sets the vertical position of the scroll bar for the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.scrollTop(valueINT);

VARIATION

myWeb = myWeb.scrollTop(valueFUNC);

NOTES

Returns a reference to the same Uize.Web object
See related scrollLeft, scrollHeight and scrollWidth methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.111. scrollWidth

Gets the width of the scroll view for the set of matched DOM nodes, including padding, but not margin.

SYNTAX

scrollHeightINT = myWeb.scrollWidth();

VARIATION

scrollWidthINT = myWeb.scrollWidth(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See related scrollTop, scrollLeft and scrollHeight methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.112. select

6.112.1. wire

Wires the specified event handler to the "select" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.select(eventHandlerFUNC);

VARIATION

myWeb = myWeb.select(eventHandlerFUNC, throttleINT);

6.112.2. trigger

Triggers a "select" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.select();

NOTES

Returns a reference to the same Uize.Web object
See the companion change method
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.113. setClassState

Updates each of the set of matched DOM nodes to contain the one CSS class out of the specified state classes that corresponds to the specified state.

SYNTAX

myWeb = myWeb.removeClassState(classNameSTR, stateBOOL);

VARIATION

myWeb = myWeb.removeClassState(classNamesARRAY, stateINT);

NOTES

Returns a reference to the same Uize.Web object
See the companion getClassState, removeClassState and toggleClassState methods
For more details see the setState method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.114. shiftAltClick

Wires the specified event handler to the "shiftAltClick" virtual event (the user clicks with only the shift and alt modifier keys pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.shiftAltClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion altClick, ctrlClick, shiftClick, ctrlAltClick, shiftCtrlClick and shiftCtrlAltClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.115. shiftClick

Wires the specified event handler to the "shiftClick" virtual event (the user clicks with only the shift modifier key pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.shiftClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion altClick, ctrlAltClick, ctrlClick, shiftAltClick, shiftCtrlClick and shiftCtrlAltClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.116. shiftCtrlAltClick

Wires the specified event handler to the "shiftCtrlAltClick" virtual event (the user clicks with only the shift and ctrl modifier keys pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.shiftCtrlAltClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion altClick, ctrlClick, shiftClick, ctrlAltClick, shiftAltClick and shiftCtrlClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.117. shiftCtrlClick

Wires the specified event handler to the "shiftCtrlClick" virtual event (the user clicks with only the shift and ctrl modifier keys pressed) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.shiftCtrlClick(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion altClick, ctrlClick, shiftClick, ctrlAltClick, shiftAltClick and shiftCtrlAltClick methods
See the related click method
See the Uize.Dom.VirtualEvent module for more information on virtual events

IMPLEMENTATION INFO

this feature was introduced in this module

6.118. show

Displays each of the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.show();

NOTES

Returns a reference to the same Uize.Web object
See the companion hide and toggleShow methods

Sets the visibility of each of the set of matched DOM nodes to visible or invisible.

SYNTAX

myWeb = myWeb.visibility(mustShowBOOL);

VARIATION

myWeb = myWeb.visibility();

NOTES

Returns a reference to the same Uize.Web object
See the companion visible and invisible methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.119. siblingIndex

IMPLEMENTATION INFO

this feature was introduced in this module

6.120. siblings

IMPLEMENTATION INFO

this feature was introduced in this module

6.121. single

IMPLEMENTATION INFO

this feature was introduced in this module

6.122. slice

IMPLEMENTATION INFO

this feature was introduced in this module

6.123. slideDown

IMPLEMENTATION INFO

this feature was introduced in this module

6.124. slideIn

IMPLEMENTATION INFO

this feature was introduced in this module

6.125. slideOut

IMPLEMENTATION INFO

this feature was introduced in this module

6.126. slideUp

IMPLEMENTATION INFO

this feature was introduced in this module

6.127. slideX

IMPLEMENTATION INFO

this feature was introduced in this module

6.128. slideY

IMPLEMENTATION INFO

this feature was introduced in this module

6.129. splice

IMPLEMENTATION INFO

this feature was introduced in this module

6.130. stop

IMPLEMENTATION INFO

this feature was introduced in this module

6.131. submit

6.131.1. wire

Wires the specified event handler to the "submit" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.submit(eventHandlerFUNC);

VARIATION

myWeb = myWeb.submit(eventHandlerFUNC, throttleINT);

6.131.2. trigger

Triggers a "submit" JavaScript event on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.submit();

NOTES

Returns a reference to the same Uize.Web object
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.132. supportsCss

Gets whether or not the set of matched DOM nodes supports the specified CSS property name in the current environment (i.e. browser).

SYNTAX

supportsSTR = myWeb.supportsCss(propertyNameSTR); // one matched node

VARIATION

supportsARRAY = myWeb.supportsCss(propertyNameSTR, returnAllBOOL); // multiple matched nodes

NOTES

Use this method instead of browser version testing to determine if a given CSS property is supported by the browser
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.
See also Uize.Web.supportsCss static method

IMPLEMENTATION INFO

this feature was introduced in this module

6.133. text

6.133.1. get

Gets the text contents for each of the set of matched DOM nodes, including their descendents.

SYNTAX

textSTR = myWeb.text(); // one matched node

VARIATION

textARRAY = myWeb.text(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

6.133.2. set

Sets the text content of every node in the set of matched DOM nodes..

SYNTAX

myWeb = myWeb.text(textSTR);

VARIATION

myWeb = myWeb.text(textFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.134. toggleClass

Toggles the presence of the specified class name(s) from each of the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.toggleClass(classNameSTR);

VARIATION

myWeb = myWeb.toggleClass(classNameFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the related addClass, hasClass and removeClass methods
See also the toggleClassState method
For more details see the toggleClass method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.135. toggleClassState

Updates each of the set of matched DOM nodes to contain the one CSS class out of the specified state classes that corresponds to the state that is obtained from the DOM node and then advanced by one.

SYNTAX

myWeb = myWeb.toggleClassState(classNameSTR);

VARIATION

myWeb = myWeb.toggleClassState(classNamesARRAY);

NOTES

Returns a reference to the same Uize.Web object
See the companion getClassState, setClassState and removeClassState methods
See the related toggleClass method
For more details see the toggleState method of the Uize.Dom.Classes module

IMPLEMENTATION INFO

this feature was introduced in this module

6.136. toggleFade

IMPLEMENTATION INFO

this feature was introduced in this module

6.137. toggleShow

Displays or hides each of the set of matched DOM nodes, depending on their current displayed state.

SYNTAX

myWeb = myWeb.toggleShow();

NOTES

Returns a reference to the same Uize.Web object
See the companion display and hide methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.138. toggleSlideX

IMPLEMENTATION INFO

this feature was introduced in this module

6.139. toggleSlideY

IMPLEMENTATION INFO

this feature was introduced in this module

6.140. touchcancel

6.140.1. wire

Wires the specified event handler to the "touchcancel" JavaScript event for touch devices to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchcancel(eventHandlerFUNC);

VARIATION

myWeb = myWeb.touchcancel(eventHandlerFUNC, throttleINT);

6.140.2. trigger

Triggers a "touchcancel" JavaScript event for touch devices on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchcancel();

NOTES

Returns a reference to the same Uize.Web object
See the companion touchend, touchleave, touchmove and touchstart methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.141. touchend

6.141.1. wire

Wires the specified event handler to the "touchend" JavaScript event for touch devices to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchend(eventHandlerFUNC);

VARIATION

myWeb = myWeb.touchend(eventHandlerFUNC, throttleINT);

6.141.2. trigger

Triggers a "touchend" JavaScript event for touch devices on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchend();

NOTES

Returns a reference to the same Uize.Web object
See the companion touchcancel, touchleave, touchmove and touchstart methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.142. touchleave

6.142.1. wire

Wires the specified event handler to the "touchleave" JavaScript event for touch devices to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchleave(eventHandlerFUNC);

VARIATION

myWeb = myWeb.touchleave(eventHandlerFUNC, throttleINT);

6.142.2. trigger

Triggers a "touchleave" JavaScript event for touch devices on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchleave();

NOTES

Returns a reference to the same Uize.Web object
See the companion touchcancel, touchend, touchmove and touchstart methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.143. touchmove

6.143.1. wire

Wires the specified event handler to the "touchmove" JavaScript event for touch devices to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchmove(eventHandlerFUNC);

VARIATION

myWeb = myWeb.touchmove(eventHandlerFUNC, throttleINT);

6.143.2. trigger

Triggers a "touchmove" JavaScript event for touch devices on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchmove();

NOTES

Returns a reference to the same Uize.Web object
See the companion touchcancel, touchend, touchleave and touchstart methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.144. touchstart

6.144.1. wire

Wires the specified event handler to the "touchstart" JavaScript event for touch devices to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchstart(eventHandlerFUNC);

VARIATION

myWeb = myWeb.touchstart(eventHandlerFUNC, throttleINT);

6.144.2. trigger

Triggers a "touchstart" JavaScript event for touch devices on the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.touchstart();

NOTES

Returns a reference to the same Uize.Web object
See the companion touchcancel, touchend, touchleave and touchmove methods
See the related wire and trigger methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.145. transitionend

Wires the specified event handler to the "transitionend" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.transitionend(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
Webkit browsers (Chrome & Safari) still use the proprietary "webkitTransitionEnd" event, so that is wired as well
See the related wire method

IMPLEMENTATION INFO

this feature was introduced in this module

6.146. trigger

Executes all the handlers attached to the set of matched DOM nodes for the specified event name.

SYNTAX

myWeb = myWeb.trigger(eventNameSTR);

VARIATION

myWeb = myWeb.trigger(eventNameSTR, eventPropertiesOBJ);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.147. unload

Wires the specified event handler to the "unload" JavaScript event to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.unload(eventHandlerFUNC);

NOTES

Returns a reference to the same Uize.Web object
See the companion load method
See the related wire method

IMPLEMENTATION INFO

this feature was introduced in this module

6.148. unwire

Removes previously wired event handler(s) from the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.unwire(eventNameSTR, eventHandlerFUNC);

VARIATION 1

myWeb = myWeb.unwire(eventNameSTR, eventHandlerFUNC, selectorSTR);

VARIATION 2

myWeb = myWeb.unwire(eventNameSTR, returnBOOL);

VARIATION 3

myWeb = myWeb.unwire(eventNameSTR, returnBOOL, selectorSTR);

VARIATION 4

myWeb = myWeb.unwire(eventNameSTR);

VARIATION 5

myWeb = myWeb.unwire(eventsMapOBJ);

VARIATION 6

myWeb = myWeb.unwire(eventsMapOBJ, selectorSTR);

VARIATION 7

myWeb = myWeb.unwire();

VARIATION 8

myWeb = myWeb.unwire(eventNamesARRAY, eventHandlerFUNC);

VARIATION 9

myWeb = myWeb.unwire(eventNamesARRAY, eventHandlerFUNC, selectorSTR);

VARIATION 10

myWeb = myWeb.unwire(eventNamesARRAY, returnBOOL);

VARIATION 11

myWeb = myWeb.unwire(eventNamesARRAY, returnBOOL, selectorSTR);

NOTES

Returns a reference to the same Uize.Web object
See companion wire and wireOnce methods
See also the unwire static method in Uize.Dom.Basics

IMPLEMENTATION INFO

this feature was introduced in this module

6.149. value

6.149.1. get

Gets the values for each of the set of matched DOM nodes.

SYNTAX

valueSTR = myWeb.value(); // one matched node

VARIATION

valueARRAY = myWeb.value(returnAllBOOL); // multiple matched nodes

NOTES

If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

6.149.2. set

Sets the value of every node in the set of matched DOM nodes..

SYNTAX

myWeb = myWeb.value(valueSTR);

VARIATION

myWeb = myWeb.value(valueFUNC);

NOTES

Returns a reference to the same Uize.Web object

IMPLEMENTATION INFO

this feature was introduced in this module

6.150. visibility

IMPLEMENTATION INFO

this feature was introduced in this module

6.151. visible

Sets the visibility of each of the set of matched DOM nodes to visible.

SYNTAX

myWeb = myWeb.visible();

NOTES

Returns a reference to the same Uize.Web object
See the companion invisible and visibility methods

IMPLEMENTATION INFO

this feature was introduced in this module

6.152. width

Gets the computed width for the set of matched DOM nodes, including padding, border, and optionally margin.

SYNTAX

widthINT = myWeb.width(); // one matched node

VARIATION

widthWithMarginsINT = myWeb.width(includeMarginBOOL); // one matched node

VARIATION 2

widthWithMarginsARRAY = myWeb.width(includeMarginBOOL, returnAllBOOL); // multiple matched nodes

NOTES

Return values are integers (without 'px', 'em', etc.)
If returnAllBOOL is set to true, then the return value for each of the matched nodes is wrapped in an array (even if there's only one matched node). If returnAllBOOL is false or unspecified (undefined), only the value for the first matched node is returned. See Dynamic Methods Return Values for more info.

IMPLEMENTATION INFO

this feature was introduced in this module

6.153. wire

Wires event handler(s) to the set of matched DOM nodes.

SYNTAX

myWeb = myWeb.wire(eventNameSTR, eventHandlerFUNC);

VARIATION 1

myWeb = myWeb.wire(eventNameSTR, eventHandlerFUNC, selectorSTR);

VARIATION 2

myWeb = myWeb.wire(eventNameSTR, returnBOOL);

VARIATION 3

myWeb = myWeb.wire(eventNameSTR, returnBOOL, selectorSTR);

VARIATION 4

myWeb = myWeb.wire(eventsMapOBJ);

VARIATION 5

myWeb = myWeb.wire(eventsMapOBJ, selectorSTR);

VARIATION 6

myWeb = myWeb.wire(eventNamesARRAY, eventHandlerFUNC);

VARIATION 7

myWeb = myWeb.wire(eventNamesARRAY, eventHandlerFUNC, selectorSTR);

VARIATION 8

myWeb = myWeb.wire(eventNamesARRAY, returnBOOL);

VARIATION 9

myWeb = myWeb.wire(eventNamesARRAY, returnBOOL, selectorSTR);

NOTES

Returns a reference to the same Uize.Web object
See companion unwire and wireOnce methods
See also the wire static method in Uize.Dom.Basics
Calls Uize.Dom.Event.fix on the event object

IMPLEMENTATION INFO

this feature was introduced in this module

6.154. wireOnce

Wires event handler(s) to the set of matched DOM nodes, with each handler executed at most once per DOM node.

SYNTAX

myWeb = myWeb.wireOnce(eventNameSTR, eventHandlerFUNC);

VARIATION 1

myWeb = myWeb.wireOnce(eventNameSTR, eventHandlerFUNC, selectorSTR);

VARIATION 2

myWeb = myWeb.wireOnce(eventNameSTR, returnBOOL);

VARIATION 3

myWeb = myWeb.wireOnce(eventNameSTR, returnBOOL, selectorSTR);

VARIATION 4

myWeb = myWeb.wireOnce(eventsMapOBJ);

VARIATION 5

myWeb = myWeb.wireOnce(eventsMapOBJ, selectorSTR);

VARIATION 6

myWeb = myWeb.wireOnce(eventNamesARRAY, eventHandlerFUNC);

VARIATION 7

myWeb = myWeb.wireOnce(eventNamesARRAY, eventHandlerFUNC, selectorSTR);

VARIATION 8

myWeb = myWeb.wireOnce(eventNamesARRAY, returnBOOL);

VARIATION 9

myWeb = myWeb.wireOnce(eventNamesARRAY, returnBOOL, selectorSTR);

NOTES

Returns a reference to the same Uize.Web object
See companion wire and unwire methods
See also the wire and unwire static method in Uize.Dom.Basics

IMPLEMENTATION INFO

this feature was introduced in this module