DocumentQuery class abstract

A query object of document.

Inheritance
Available Extensions

Constructors

DocumentQuery()

Properties

context → dynamic
The DOM node context originally passed to Query; if none was passed
no setterinherited
cookies Map<String, String>
Returns all cookies.
no setter
data Data
The interface to access custom element data.
no setterinherited
first HtmlDocument
The first element.
getter/setter pairinherited
firstIfAny HtmlDocument?
Return the first matched element, or null if empty.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
height int?
Retrieve the height of the first element of this collection.
no setterinherited
isEmpty bool
Whether this collection has no elements.
no setterinherited
isNotEmpty bool
Whether this collection has at least one element.
no setterinherited
iterator Iterator<HtmlDocument>
A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
last HtmlDocument
The last element.
getter/setter pairinherited
length int
The number of objects in this list.
getter/setter pairinherited
reversed Iterable<HtmlDocument>
An Iterable of the objects in this list in reverse order.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollLeft int?
Get the current horizontal position of the scroll bar for the first element
getter/setter pairinherited
scrollTop int?
Get the current vertical position of the scroll bar for the first element
getter/setter pairinherited
selector String?
no setterinherited
single HtmlDocument
Checks that this iterable has only one element, and returns that element.
no setterinherited
width int?
Retrieve the width of the first element of this collection.
no setterinherited

Methods

add(HtmlDocument value) → void
Adds value to the end of this list, extending the length by one.
inherited
addAll(Iterable<HtmlDocument> iterable) → void
Appends all objects of iterable to the end of this list.
inherited
any(bool test(HtmlDocument element)) bool
Checks whether any element of this iterable satisfies test.
inherited
asMap() Map<int, HtmlDocument>
An unmodifiable Map view of this list.
inherited
cast<R>() List<R>
Returns a view of this list as a list of R instances.
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero.
inherited
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
Accesses the cookie. *
elementAt(int index) HtmlDocument
Returns the indexth element.
inherited
end() Query
Pops out the top Query object in the stack and retrieve the previous one.
inherited
every(bool test(HtmlDocument element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(HtmlDocument element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
fillRange(int start, int end, [HtmlDocument? fillValue]) → void
Overwrites a range of elements with fillValue.
inherited
find(String selector) ElementQuery
Retrieve an ElementQuery containing descendants of this element collection
inherited
firstWhere(bool test(HtmlDocument element), {HtmlDocument orElse()?}) HtmlDocument
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, HtmlDocument element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<HtmlDocument> other) Iterable<HtmlDocument>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(HtmlDocument element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
getRange(int start, int end) Iterable<HtmlDocument>
Creates an Iterable that iterates over a range of elements.
inherited
indexOf(HtmlDocument element, [int start = 0]) int
The first index of element in this list.
inherited
indexWhere(bool test(HtmlDocument element), [int start = 0]) int
The first index in the list that satisfies the provided test.
inherited
insert(int index, HtmlDocument element) → void
Inserts element at position index in this list.
inherited
insertAll(int index, Iterable<HtmlDocument> iterable) → void
Inserts all objects of iterable at position index in this list.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastIndexOf(HtmlDocument element, [int? start]) int
The last index of element in this list.
inherited
lastIndexWhere(bool test(HtmlDocument element), [int? start]) int
The last index in the list that satisfies the provided test.
inherited
lastWhere(bool test(HtmlDocument element), {HtmlDocument orElse()?}) HtmlDocument
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(HtmlDocument e)) Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off(String types, {String? selector, QueryEventListener? handler}) → void
Unregister a handler for events of given types.
inherited
on(String types, QueryEventListener handler, {String? selector}) → void
Register a handler for events of given types on selected elements.
inherited
one(String types, QueryEventListener handler, {String? selector}) → void
Register a one-time handler for events of given types. Once called,
inherited
pushStack(List<Element> elems) ElementQuery
Add a collection of DOM elements onto the Query stack.
inherited
reduce(HtmlDocument combine(HtmlDocument value, HtmlDocument element)) HtmlDocument
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(Object? value) bool
Removes the first occurrence of value from this list.
inherited
removeAt(int index) HtmlDocument
Removes the object at position index from this list.
inherited
removeCookie(String name) → void
Removes the cookie.
removeLast() HtmlDocument
Removes and returns the last object in this list.
inherited
removeRange(int start, int end) → void
Removes a range of elements from the list.
inherited
removeWhere(bool test(HtmlDocument element)) → void
Removes all objects from this list that satisfy test.
inherited
replaceRange(int start, int end, Iterable<HtmlDocument> replacements) → void
Replaces a range of elements with the elements of replacements.
inherited
retainWhere(bool test(HtmlDocument element)) → void
Removes all objects from this list that fail to satisfy test.
inherited
setAll(int index, Iterable<HtmlDocument> iterable) → void
Overwrites elements with the objects of iterable.
inherited
setRange(int start, int end, Iterable<HtmlDocument> iterable, [int skipCount = 0]) → void
Writes some elements of iterable into a range of this list.
inherited
shuffle([Random? random]) → void
Shuffles the elements of this list randomly.
inherited
singleWhere(bool test(HtmlDocument element), {HtmlDocument orElse()?}) HtmlDocument
The single element that satisfies test.
inherited
skip(int count) Iterable<HtmlDocument>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(HtmlDocument value)) Iterable<HtmlDocument>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
sort([int compare(HtmlDocument a, HtmlDocument b)?]) → void
Sorts this list according to the order specified by the compare function.
inherited
sublist(int start, [int? end]) List<HtmlDocument>
Returns a new list containing the elements between start and end.
inherited
take(int count) Iterable<HtmlDocument>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(HtmlDocument value)) Iterable<HtmlDocument>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<HtmlDocument>
Creates a List containing the elements of this Iterable.
inherited
toSet() Set<HtmlDocument>
Creates a Set containing the same elements as this iterable.
inherited
toString() String
A string representation of this object.
inherited
trigger(String type, {dynamic data}) → void
Trigger an event of given type on all matched elements, with given
inherited
triggerEvent(QueryEvent event) → void
Trigger the given event on all matched elements, with given data if
inherited
triggerHandler(String type, {dynamic data}) → void
Trigger an event of given type on the first (if any) matched element,
inherited
where(bool test(HtmlDocument element)) Iterable<HtmlDocument>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator +(List<HtmlDocument> other) List<HtmlDocument>
Returns the concatenation of this list and other.
inherited
operator ==(Object other) bool
The equality operator.
inherited
operator [](int index) HtmlDocument
The object at the given index in the list.
inherited
operator []=(int index, HtmlDocument value) → void
Sets the value at the given index in the list to value.
inherited