API Reference 0.5.2dqueryWindowQuery

WindowQuery abstract class

A query object of a Window.

abstract class WindowQuery extends DQuery<Window> {
 factory WindowQuery([Window window]) => new _WinQuery(window);
}

Extends

DQuery<Window> > WindowQuery

Constructors

factory WindowQuery([Window window]) #

factory WindowQuery([Window window]) => new _WinQuery(window);

Properties

final context #

inherited from DQuery

The DOM node context originally passed to DQuery; if none was passed then context will likely be the document.

get context;

final Data data #

inherited from DQuery

The interface to access custom element data.

Data get data;

final E first #

inherited from Iterable

Returns the first element.

If this is empty throws a StateError. Otherwise this method is equivalent to this.elementAt(0)

E get first;

final T firstIfAny #

inherited from DQuery

Return the first matched element, or null if empty.

T get firstIfAny;

final int height #

inherited from DQuery

Retrieve the height of the first element of this collection.

int get height;

final bool isEmpty #

inherited from Iterable

Returns true if there is no element in this collection.

bool get isEmpty;

final bool isNotEmpty #

inherited from Iterable

Returns true if there is at least one element in this collection.

bool get isNotEmpty;

final Iterator<E> iterator #

inherited from Iterable

Returns an Iterator that iterates over this Iterable object.

Iterator<E> get iterator;

final E last #

inherited from Iterable

Returns the last element.

If this is empty throws a StateError.

E get last;

abstract int get length #

inherited from List

Returns the number of elements in the list.

The valid indices for a list are 0 through length - 1.

abstract void set length(int newLength) #

inherited from List

Changes the length of the list. If newLength is greater than the current length, entries are initialized to null.

Throws an UnsupportedError if the list is not extendable.

final Iterable<E> reversed #

inherited from List

Returns an Iterable of the elements of this List in reverse order.

Iterable<E> get reversed;

abstract int get scrollLeft #

inherited from DQuery

Get the current horizontal position of the scroll bar for the first element in this collection.

abstract void set scrollLeft(int value) #

inherited from DQuery

Set the current horizontal position of the scroll bar for all elements in this collection.

abstract int get scrollTop #

inherited from DQuery

Get the current vertical position of the scroll bar for the first element in this collection.

abstract void set scrollTop(int value) #

inherited from DQuery

Set the current vertical position of the scroll bar for all elements in this collection.

final String selector #

inherited from DQuery
String get selector;

final E single #

inherited from Iterable

Returns the single element in this.

If this is empty or has more than one element throws a StateError.

E get single;

final int width #

inherited from DQuery

Retrieve the width of the first element of this collection.

int get width;

Operators

abstract E operator [](int index) #

inherited from List

Returns the element at the given index in the list or throws an RangeError if index is out of bounds.

abstract void operator []=(int index, E value) #

inherited from List

Sets the entry at the given index in the list to value.

Throws an RangeError if index is out of bounds.

Methods

abstract void add(E value) #

inherited from List

Adds value at the end of the list, extending the length by one.

Throws an UnsupportedError if the list is not extendable.

abstract void addAll(Iterable<E> iterable) #

inherited from List

Appends all elements of the iterable to the end of this list.

Extends the length of the list by the number of elements in iterable. Throws an UnsupportedError if this list is not extensible.

abstract bool any(bool test(E element)) #

inherited from Iterable

Returns true if one element of this collection satisfies the predicate test. Returns false otherwise.

abstract Map<int, E> asMap() #

inherited from List

Returns an unmodifiable Map view of this.

It has the indices of this list as keys, and the corresponding elements as values. The [Map.keys] [Iterable] will iterate the indices of this list in numerical order.

abstract void clear() #

inherited from List

Removes all elements in the list.

The length of the list becomes zero.

Throws an UnsupportedError, and retains all elements, if the length of the list cannot be changed.

abstract bool contains(E element) #

inherited from Iterable

Check whether the collection contains an element equal to element.

abstract E elementAt(int index) #

inherited from Iterable

Returns the indexth element.

If this has fewer than index elements throws a RangeError.

Note: if this does not have a deterministic iteration order then the function may simply return any element without any iteration if there are at least index elements in this.

abstract DQuery end() #

inherited from DQuery

Pops out the top DQuery object in the stack and retrieve the previous one. If there is no previous DQuery, an empty DQuery will be returned. @see pushStack

abstract bool every(bool test(E element)) #

inherited from Iterable

Returns true if every elements of this collection satisify the predicate test. Returns false otherwise.

abstract Iterable expand(Iterable f(E element)) #

inherited from Iterable

Expand each element of this Iterable into zero or more elements.

The resulting Iterable will run through the elements returned by f for each element of this, in order.

The returned Iterable is lazy, and will call f for each element of this every time it's iterated.

abstract void fillRange(int start, int end, [E fillValue]) #

inherited from List

Sets the elements in the range start to end exclusive to the given fillValue.

It is an error if start.. end is not a valid range pointing into the this.

abstract ElementQuery find(String selector) #

inherited from DQuery

Retrieve an ElementQuery containing descendants of this element collection which match the given selector.

abstract E firstWhere(bool test(E element), {E orElse()}) #

inherited from Iterable

Returns the first element that satisfies the given predicate test.

If none matches, the result of invoking the orElse function is returned. By default, when orElse is null, a StateError is thrown.

abstract dynamic fold(initialValue, combine(previousValue, E element)) #

inherited from Iterable

Reduces a collection to a single value by iteratively combining each element of the collection with an existing value using the provided function.

Use initialValue as the initial value, and the function combine to create a new value from the previous one and an element.

Example of calculating the sum of an iterable:

iterable.fold(0, (prev, element) => prev + element);

abstract void forEach(void f(E element)) #

inherited from Iterable

Applies the function f to each element of this collection.

abstract Iterable<E> getRange(int start, int end) #

inherited from List

Returns an Iterable that iterators over the elements in the range start to end exclusive. The result of this function is backed by this.

It is an error if end is before start.

It is an error if the start and end are not valid ranges at the time of the call to this method. The returned Iterable behaves similar to skip(start).take(end - start). That is, it will not throw exceptions if this changes size.

Example:

var list = [1, 2, 3, 4, 5];
var range = list.getRange(1, 4);
print(range.join(', '));  // => 2, 3, 4
list.length = 3;
print(range.join(', '));  // => 2, 3

abstract int indexOf(E element, [int start = 0]) #

inherited from List

Returns the first index of element in the list.

Searches the list from index start to the length of the list. The first time an element e is encountered so that e == element, the index of e is returned. Returns -1 if element is not found.

abstract void insert(int index, E element) #

inherited from List

Inserts the element at position index in the list.

This increases the length of the list by one and shifts all elements at or after the index towards the end of the list.

It is an error if the index does not point inside the list or at the position after the last element.

abstract void insertAll(int index, Iterable<E> iterable) #

inherited from List

Inserts all elements of iterable at position index in the list.

This increases the length of the list by the length of iterable and shifts all later elements towards the end of the list.

It is an error if the index does not point inside the list or at the position after the last element.

String join([String separator = ""]) #

inherited from Iterable

Converts each element to a String and concatenates the strings.

Converts each element to a String by calling Object.toString on it. Then concatenates the strings, optionally separated by the separator string.

String join([String separator = ""]) {
 StringBuffer buffer = new StringBuffer();
 buffer.writeAll(this, separator);
 return buffer.toString();
}

abstract int lastIndexOf(E element, [int start]) #

inherited from List

Returns the last index of element in the list.

Searches the list backwards from index start to 0.

The first time an element e is encountered so that e == element, the index of e is returned.

If start is not provided, it defaults to this.length - 1.

Returns -1 if element is not found.

abstract E lastWhere(bool test(E element), {E orElse()}) #

inherited from Iterable

Returns the last element that satisfies the given predicate test.

If none matches, the result of invoking the orElse function is returned. By default, when orElse is null, a StateError is thrown.

abstract Iterable map(f(E element)) #

inherited from Iterable

Returns a lazy Iterable where each element e of this is replaced by the result of f(e).

This method returns a view of the mapped elements. As long as the returned Iterable is not iterated over, the supplied function f will not be invoked. The transformed elements will not be cached. Iterating multiple times over the the returned Iterable will invoke the supplied function f multiple times on the same element.

abstract void off(String types, {String selector, DQueryEventListener handler}) #

inherited from DQuery

Unregister a handler for events of given types. // TODO

abstract void on(String types, DQueryEventListener handler, {String selector}) #

inherited from DQuery

Register a handler for events of given types on selected elements. + If selector is provided, only the descendant elements matched by the selector will trigger the event. If omitted or null, the event will always be triggered. + If data is provided, you can retrieve it in event.data in the handler.

abstract void one(String types, DQueryEventListener handler, {String selector}) #

inherited from DQuery

Register a one-time handler for events of given types. Once called, the handler will be unregistered. + If selector is provided, only the descendant elements matched by the selector will trigger the event. If omitted or null, the event will always be triggered. + If data is provided, you can retrieve it in event.data in the handler.

abstract ElementQuery pushStack(List<Element> elems) #

inherited from DQuery

Add a collection of DOM elements onto the DQuery stack.

abstract E reduce(E combine(E value, E element)) #

inherited from Iterable

Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.

Example of calculating the sum of an iterable:

iterable.reduce((value, element) => value + element);

abstract bool remove(Object value) #

inherited from List

Removes value from the list. Returns true if value was in the list. Returns false otherwise. The method has no effect if value value was not in the list.

abstract E removeAt(int index) #

inherited from List

Removes the element at position index from the list.

This reduces the length of this by one and moves all later elements down by one position.

Returns the removed element.

Throws an ArgumentError if index is not an int.

Throws an RangeError if the index does not point inside the list.

Throws an UnsupportedError, and doesn't remove the element, if the length of this cannot be changed.

abstract E removeLast() #

inherited from List

Pops and returns the last element of the list. Throws a UnsupportedError if the length of the list cannot be changed.

abstract void removeRange(int start, int end) #

inherited from List

Removes the elements in the range start to end exclusive.

It is an error if start.. end is not a valid range pointing into the this.

abstract void removeWhere(bool test(E element)) #

inherited from List

Removes all elements of this list that satisfy test.

An elements e satisfies test if test(e) is true.

abstract void replaceRange(int start, int end, Iterable<E> iterable) #

inherited from List

Removes the elements in the range start to end exclusive and replaces them with the contents of the iterable.

It is an error if start.. end is not a valid range pointing into the this.

Example:

var list = [1, 2, 3, 4, 5];
list.replaceRange(1, 3, [6, 7, 8, 9]);
print(list);  // [1, 6, 7, 8, 9, 4, 5]

abstract void retainWhere(bool test(E element)) #

inherited from List

Removes all elements of this list that fail to satisfy test.

An elements e satisfies test if test(e) is true.

abstract void setAll(int index, Iterable<E> iterable) #

inherited from List

Overwrites elements of this with the elemenst of iterable starting at position index in the list.

This operation does not increase the length of this.

It is an error if the index does not point inside the list or at the position after the last element.

It is an error if the iterable is longer than length - index.

abstract void setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) #

inherited from List

Copies the elements of iterable, skipping the skipCount first elements, into the range start to end exclusive of this.

If start equals end and start.. end represents a legal range, this method has no effect.

It is an error if start.. end is not a valid range pointing into the this.

It is an error if the iterable does not have enough elements after skipping skipCount elements.

Example:

var list = [1, 2, 3, 4];
var list2 = [5, 6, 7, 8, 9];
list.setRange(1, 3, list2, 3);
print(list);  // => [1, 8, 9, 4]

abstract E singleWhere(bool test(E element)) #

inherited from Iterable

Returns the single element that satisfies test. If no or more than one element match then a StateError is thrown.

abstract Iterable<E> skip(int n) #

inherited from Iterable

Returns an Iterable that skips the first n elements.

If this has fewer than n elements, then the resulting Iterable will be empty.

abstract Iterable<E> skipWhile(bool test(E value)) #

inherited from Iterable

Returns an Iterable that skips elements while test is satisfied.

The filtering happens lazily. Every new Iterator of the returned Iterable iterates over all elements of this.

As long as the iterator's elements satisfy test they are discarded. Once an element does not satisfy the test the iterator stops testing and uses every later element unconditionally. That is, the elements of the returned Iterable are the elements of this starting from the first element that does not satisfy test.

abstract void sort([int compare(E a, E b)]) #

inherited from List

Sorts the list according to the order specified by the compare function.

The compare function must act as a Comparator.

The default List implementations use Comparable.compare if compare is omitted.

abstract List<E> sublist(int start, [int end]) #

inherited from List

Returns a new list containing the elements from start to end.

If end is omitted, the length of this is used.

It is an error if start or end are not indices into this, or if end is before start.

abstract Iterable<E> take(int n) #

inherited from Iterable

Returns an Iterable with at most n elements.

The returned Iterable may contain fewer than n elements, if this contains fewer than n elements.

abstract Iterable<E> takeWhile(bool test(E value)) #

inherited from Iterable

Returns an Iterable that stops once test is not satisfied anymore.

The filtering happens lazily. Every new Iterator of the returned Iterable will start iterating over the elements of this.

When the iterator encounters an element e that does not satisfy test, it discards e and moves into the finished state. That is, it will not ask or provide any more elements.

abstract List<E> toList({bool growable: true}) #

inherited from Iterable

Creates a List containing the elements of this Iterable.

The elements will be in iteration order. The list is fixed-length if growable is false.

abstract Set<E> toSet() #

inherited from Iterable

Creates a Set containing the elements of this Iterable.

abstract void trigger(String type, {data}) #

inherited from DQuery

Trigger an event of given type on all matched elements, with given data if provided.

abstract void triggerEvent(DQueryEvent event) #

inherited from DQuery

Trigger the given event on all matched elements, with given data if provided.

abstract void triggerHandler(String type, {data}) #

inherited from DQuery

Trigger an event of given type on the first (if any) matched element, with given data if provided. However, only the registered handlers will be called, while the default action is omitted.

abstract Iterable<E> where(bool test(E element)) #

inherited from Iterable

Returns a lazy Iterable with all elements that satisfy the predicate test.

This method returns a view of the mapped elements. As long as the returned Iterable is not iterated over, the supplied function test will not be invoked. Iterating will not cache results, and thus iterating multiple times over the the returned Iterable will invoke the supplied function test multiple times on the same element.