tinymce.dom.DomQuery
This class mimics most of the jQuery API: This is whats currently implemented: - Utility functions - DOM traversial - DOM manipulation - Event binding This is not currently implemented: - Dimension - Ajax - Animation - Advanced chaining
DomQuery has been deprecated in TinyMCE 5.10 and has been marked for removal in TinyMCE 6.0.
Examples
var $ = tinymce.dom.DomQuery;
$('p').attr('attr', 'value').addClass('class');
Properties
name | type | summary | defined by |
---|---|---|---|
context | Element | Context used to create the set. | tinymce.dom.DomQuery |
length | Number | Number of items in the current set. | tinymce.dom.DomQuery |
selector | String | Selector for the current set. | tinymce.dom.DomQuery |
Constructors
name | summary | defined by |
---|---|---|
DomQuery() | Constructs a new DomQuery instance with the specified selector or context. | tinymce.dom.DomQuery |
Methods
name | summary | defined by |
---|---|---|
add() | Adds new nodes to the set. | tinymce.dom.DomQuery |
addClass() | Adds the specified class name to the current set elements. | tinymce.dom.DomQuery |
after() | Adds the specified elements after current set nodes. | tinymce.dom.DomQuery |
append() | Appends the specified node/html or node set to the current set nodes. | tinymce.dom.DomQuery |
appendTo() | Appends the specified set nodes to the specified selector/instance. | tinymce.dom.DomQuery |
attr() | Sets/gets properties on the elements in the current set. | tinymce.dom.DomQuery |
before() | Adds the specified elements before current set nodes. | tinymce.dom.DomQuery |
children() | Returns all child elements matching the optional selector. | tinymce.dom.DomQuery |
clone() | Clones all nodes in set. | tinymce.dom.DomQuery |
closest() | Gets the current node or any parent matching the specified selector. | tinymce.dom.DomQuery |
contents() | Returns all child nodes matching the optional selector. | tinymce.dom.DomQuery |
css() | Sets/gets styles on the elements in the current set. | tinymce.dom.DomQuery |
each() | Executes the callback function for each item DomQuery collection. If you return false in the callback it will break the loop. | tinymce.dom.DomQuery |
each() | Executes the callback function for each item in array/object. If you return false in the callback it will break the loop. | tinymce.dom.DomQuery |
empty() | Empties all elements in set. | tinymce.dom.DomQuery |
eq() | Makes the set equal to the specified index. | tinymce.dom.DomQuery |
extend() | Extends the specified object with one or more objects. | tinymce.dom.DomQuery |
filter() | Filters the current set with the specified selector. | tinymce.dom.DomQuery |
find() | Finds elements by the specified selector for each element in set. | tinymce.dom.DomQuery |
first() | Makes the set equal to first element in set. | tinymce.dom.DomQuery |
grep() | Filters out items from the input array by calling the specified function for each item. If the function returns false the item will be excluded if it returns true it will be included. | tinymce.dom.DomQuery |
hasClass() | Returns true/false if the first item in set has the specified class. | tinymce.dom.DomQuery |
hide() | Hides all elements in set. | tinymce.dom.DomQuery |
html() | Sets or gets the HTML of the current set or first set node. | tinymce.dom.DomQuery |
inArray() | Returns the index of the specified item inside the array. | tinymce.dom.DomQuery |
is() | Returns true/false if the current set items matches the selector. | tinymce.dom.DomQuery |
isArray() | Returns true/false if the specified object is an array or not. | tinymce.dom.DomQuery |
last() | Makes the set equal to last element in set. | tinymce.dom.DomQuery |
makeArray() | Creates an array out of an array like object. | tinymce.dom.DomQuery |
next() | Returns a new collection with next sibling of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
nextUntil() | Returns a new collection with all next siblings of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
off() | Unbinds an event with callback function to the elements in set. | tinymce.dom.DomQuery |
offset() | Returns the offset of the first element in set or sets the top/left css properties of all elements in set. | tinymce.dom.DomQuery |
on() | Binds an event with callback function to the elements in set. | tinymce.dom.DomQuery |
parent() | Returns a new collection with the parent of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
parents() | Returns a new collection with the all the parents of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
parentsUntil() | Returns a new collection with the all the parents until the matching selector/element of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
prepend() | Prepends the specified node/html or node set to the current set nodes. | tinymce.dom.DomQuery |
prependTo() | Prepends the specified set nodes to the specified selector/instance. | tinymce.dom.DomQuery |
prev() | Returns a new collection with previous sibling of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
prevUntil() | Returns a new collection with all previous siblings of each item in current collection matching the optional selector. | tinymce.dom.DomQuery |
remove() | Removes all nodes in set from the document. | tinymce.dom.DomQuery |
removeAttr() | Removes attributse on the elements in the current set. | tinymce.dom.DomQuery |
removeClass() | Removes the specified class name to the current set elements. | tinymce.dom.DomQuery |
replaceWith() | Replaces the nodes in set with the specified content. | tinymce.dom.DomQuery |
show() | Shows all elements in set. | tinymce.dom.DomQuery |
slice() | Slices the current set. | tinymce.dom.DomQuery |
text() | Sets or gets the text of the current set or first set node. | tinymce.dom.DomQuery |
toArray() | Converts the current set to an array. | tinymce.dom.DomQuery |
toggleClass() | Toggles the specified class name on the current set elements. | tinymce.dom.DomQuery |
trigger() | Triggers the specified event by name or event object. | tinymce.dom.DomQuery |
trim() | Removes whitespace from the beginning and end of a string. | tinymce.dom.DomQuery |
unwrap() | Unwraps all elements by removing the parent element of each item in set. | tinymce.dom.DomQuery |
wrap() | Wraps all elements in set with the specified wrapper. | tinymce.dom.DomQuery |
wrapAll() | Wraps all nodes in set with the specified wrapper. If the nodes are siblings all of them will be wrapped in the same wrapper. | tinymce.dom.DomQuery |
wrapInner() | Wraps all elements inner contents in set with the specified wrapper. | tinymce.dom.DomQuery |
Constructors
DomQuery
Constructs a new DomQuery instance with the specified selector or context.
Parameters
- selector (String) - Optional CSS selector/Array or array like object or HTML string.
- context (Document) - Optional context to search in.
Methods
add
Adds new nodes to the set.
Parameters
- items (Array) - Array of all nodes to add to set.
- sort (Boolean) - Optional sort flag that enables sorting of elements.
Return value
- tinymce.dom.DomQuery - New instance with nodes added.
addClass
Adds the specified class name to the current set elements.
Parameters
- className (String) - Class name to add.
Return value
- tinymce.dom.DomQuery - Current set.
after
Adds the specified elements after current set nodes.
Parameters
- content (String) - Content to add after to each element in set.
Return value
- tinymce.dom.DomQuery - Current set.
append
Appends the specified node/html or node set to the current set nodes.
Parameters
- content (String) - Content to append to each element in set.
Return value
- tinymce.dom.DomQuery - Current set.
appendTo
Appends the specified set nodes to the specified selector/instance.
Parameters
- val (String) - Item to append the current set to.
Return value
- tinymce.dom.DomQuery - Current set with the appended nodes.
attr
Sets/gets properties on the elements in the current set.
Parameters
- name (String) - Name of property to get or an object with properties to set.
- value (String) - Optional value to set.
Return value
- tinymce.dom.DomQuery - Current set or the specified property when only the name is specified.
- String - Current set or the specified property when only the name is specified.
before
Adds the specified elements before current set nodes.
Parameters
- content (String) - Content to add before to each element in set.
Return value
- tinymce.dom.DomQuery - Current set.
children
Returns all child elements matching the optional selector.
Parameters
- node (Element) - Node to match the elements against.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching elements.
clone
Clones all nodes in set.
Return value
- tinymce.dom.DomQuery - Set with cloned nodes.
closest
Gets the current node or any parent matching the specified selector.
Parameters
- selector (String) - Selector or element to find.
Return value
- tinymce.dom.DomQuery - Set with closest elements.
contents
Returns all child nodes matching the optional selector.
Parameters
- node (Element) - Node to get the contents of.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching elements.
css
Sets/gets styles on the elements in the current set.
Parameters
- name (String) - Name of style to get or an object with styles to set.
- value (String) - Optional value to set.
Return value
- tinymce.dom.DomQuery - Current set or the specified style when only the name is specified.
- String - Current set or the specified style when only the name is specified.
each
Executes the callback function for each item DomQuery collection. If you return false in the callback it will break the loop.
Parameters
- callback (function) - Callback function to execute for each item.
Return value
- tinymce.dom.DomQuery - Current set.
each
Executes the callback function for each item in array/object. If you return false in the callback it will break the loop.
Parameters
- obj (Object) - Object to iterate.
- callback (function) - Callback function to execute for each item.
empty
Empties all elements in set.
Return value
- tinymce.dom.DomQuery - Current set with the empty nodes.
eq
Makes the set equal to the specified index.
Parameters
- index (Number) - Index to set it equal to.
Return value
- tinymce.dom.DomQuery - Single item set.
extend
Extends the specified object with one or more objects.
Parameters
- target (Object) - Target object to extend with new items.
- object (Object..) - Object to extend the target with.
Return value
- Object - Extended input object.
filter
Filters the current set with the specified selector.
Parameters
- selector (String) - Selector to filter elements by.
Return value
- tinymce.dom.DomQuery - Set with filtered elements.
find
Finds elements by the specified selector for each element in set.
Parameters
- selector (String) - Selector to find elements by.
Return value
- tinymce.dom.DomQuery - Set with matches elements.
first
Makes the set equal to first element in set.
Return value
- tinymce.dom.DomQuery - Single item set.
grep
Filters out items from the input array by calling the specified function for each item. If the function returns false the item will be excluded if it returns true it will be included.
Examples
// Filter out some items, this will return an array with 4 and 5
var items = DomQueryBuilder.grep([1, 2, 3, 4, 5], function(v) {return v > 3;});
Parameters
- array (Array) - Array of items to loop though.
- callback (function) - Function to call for each item. Include/exclude depends on it's return value.
Return value
- Array - New array with values imported and filtered based in input.
hasClass
Returns true/false if the first item in set has the specified class.
Examples
// To check if the first 'a' element has the class 'anchor':
tinymce.dom.DomQuery('a').hasClass('anchor')
Parameters
- className (String) - Class name to check for.
Return value
- Boolean - True/false if the set has the specified class.
hide
Hides all elements in set.
Return value
- tinymce.dom.DomQuery - Current set.
html
Sets or gets the HTML of the current set or first set node.
Parameters
- value (String) - Optional innerHTML value to set on each element.
Return value
- tinymce.dom.DomQuery - Current set or the innerHTML of the first element.
- String - Current set or the innerHTML of the first element.
inArray
Returns the index of the specified item inside the array.
Parameters
- item (Object) - Item to look for.
- array (Array) - Array to look for item in.
Return value
- Number - Index of the item or -1.
is
Returns true/false if the current set items matches the selector.
Parameters
- selector (String) - Selector to match the elements against.
Return value
- Boolean - True/false if the current set matches the selector.
isArray
Returns true/false if the specified object is an array or not.
Parameters
- array (Object) - Object to check if it's an array or not.
Return value
- Boolean - True/false if the object is an array.
last
Makes the set equal to last element in set.
Return value
- tinymce.dom.DomQuery - Single item set.
makeArray
Creates an array out of an array like object.
Parameters
- object (Object) - Object to convert to array.
Return value
- Array - Array produced from object.
next
Returns a new collection with next sibling of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to match the next element against.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching elements.
nextUntil
Returns a new collection with all next siblings of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to find next siblings on.
- until (String) - Until the matching selector or element.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching elements.
off
Unbinds an event with callback function to the elements in set.
Parameters
- name (String) - Optional name of the event to bind.
- callback (function) - Optional callback function to execute when the event occurs.
Return value
- tinymce.dom.DomQuery - Current set.
offset
Returns the offset of the first element in set or sets the top/left css properties of all elements in set.
Parameters
- offset (Object) - Optional offset object to set on each item.
Return value
- Object - Returns the first element offset or the current set if you specified an offset.
- tinymce.dom.DomQuery - Returns the first element offset or the current set if you specified an offset.
on
Binds an event with callback function to the elements in set.
Parameters
- name (String) - Name of the event to bind.
- callback (function) - Callback function to execute when the event occurs.
Return value
- tinymce.dom.DomQuery - Current set.
parent
Returns a new collection with the parent of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to match parents against.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching parents.
parents
Returns a new collection with the all the parents of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to match parents against.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching parents.
parentsUntil
Returns a new collection with the all the parents until the matching selector/element of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to find parent of.
- until (String) - Until the matching selector or element.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching parents.
prepend
Prepends the specified node/html or node set to the current set nodes.
Parameters
- content (String) - Content to prepend to each element in set.
Return value
- tinymce.dom.DomQuery - Current set.
prependTo
Prepends the specified set nodes to the specified selector/instance.
Parameters
- val (String) - Item to prepend the current set to.
Return value
- tinymce.dom.DomQuery - Current set with the prepended nodes.
prev
Returns a new collection with previous sibling of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to match the previous element against.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching elements.
prevUntil
Returns a new collection with all previous siblings of each item in current collection matching the optional selector.
Parameters
- node (Element) - Node to find previous siblings on.
- until (String) - Until the matching selector or element.
Return value
- tinymce.dom.DomQuery - New DomQuery instance with all matching elements.
remove
Removes all nodes in set from the document.
Return value
- tinymce.dom.DomQuery - Current set with the removed nodes.
removeAttr
Removes attributse on the elements in the current set.
Parameters
- name (String) - Name of attribute to remove.
Return value
- tinymce.dom.DomQuery - Current set.
- String - Current set.
removeClass
Removes the specified class name to the current set elements.
Parameters
- className (String) - Class name to remove.
Return value
- tinymce.dom.DomQuery - Current set.
replaceWith
Replaces the nodes in set with the specified content.
Parameters
- content (String) - Content to replace nodes with.
Return value
- tinymce.dom.DomQuery - Set with replaced nodes.
show
Shows all elements in set.
Return value
- tinymce.dom.DomQuery - Current set.
slice
Slices the current set.
Parameters
- start (Number) - Start index to slice at.
- end (Number) - Optional end index to end slice at.
Return value
- tinymce.dom.DomQuery - Sliced set.
text
Sets or gets the text of the current set or first set node.
Parameters
- value (String) - Optional innerText value to set on each element.
Return value
- tinymce.dom.DomQuery - Current set or the innerText of the first element.
- String - Current set or the innerText of the first element.
toArray
Converts the current set to an array.
Return value
- Array - Array of all nodes in set.
toggleClass
Toggles the specified class name on the current set elements.
Parameters
- className (String) - Class name to add/remove.
- state (Boolean) - Optional state to toggle on/off.
Return value
- tinymce.dom.DomQuery - Current set.
trigger
Triggers the specified event by name or event object.
Parameters
- name (String) - Name of the event to trigger or event object.
Return value
- tinymce.dom.DomQuery - Current set.
trim
Removes whitespace from the beginning and end of a string.
Parameters
- str (String) - String to remove whitespace from.
Return value
- String - New string with removed whitespace.
unwrap
Unwraps all elements by removing the parent element of each item in set.
Return value
- tinymce.dom.DomQuery - Set with unwrapped nodes.
wrap
Wraps all elements in set with the specified wrapper.
Parameters
- content (String) - Content to wrap nodes with.
Return value
- tinymce.dom.DomQuery - Set with wrapped nodes.
wrapAll
Wraps all nodes in set with the specified wrapper. If the nodes are siblings all of them will be wrapped in the same wrapper.
Parameters
- content (String) - Content to wrap nodes with.
Return value
- tinymce.dom.DomQuery - Set with wrapped nodes.
wrapInner
Wraps all elements inner contents in set with the specified wrapper.
Parameters
- content (String) - Content to wrap nodes with.
Return value
- tinymce.dom.DomQuery - Set with wrapped nodes.
Can't find what you're looking for? Let us know.
Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.