ElementSelector (coderad-common 2.0-pre4 API)

java.lang.Object
- com.codename1.rad.io.ElementSelector

All Implemented Interfaces:

Iterable<Element>, Collection<Element>, Set<Element>
```
public class ElementSelector
extends Object
implements Iterable<Element>, Set<Element>
```
A query selector similar to the ComponentSelector for working with XML documents.

Author:

shannah

Constructor Summary

Constructors
Constructor and Description
`ElementSelector(Element... els)` Creates a element selector that wraps the provided elements.
`ElementSelector(Set<Element> cmps)` Creates a component selector that wraps the provided components.
`ElementSelector(String selector, Collection<Element> roots)` Creates a selector with the provided roots.
`ElementSelector(String selector, Element... roots)` Creates a selector with the provided roots.
`ElementSelector(String selector, Set<Element> roots)` Creates an element selector with the given selector on the provided roots.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Element e)` Explicitly adds a component to the result set.
`boolean`	`addAll(Collection<? extends Element> c)` Adds all components in the given collection to the result set.
`ElementSelector`	`append(Element child)` Appends a child component to the first container in this set.
`ElementSelector`	`append(Object constraint, Element child)` Appends a child component to the first container in this set.
`void`	`clear()`
`boolean`	`contains(Object o)` Checks if an object is contained in result set.
`boolean`	`containsAll(Collection<?> c)` Checks if the result set contains all of the components found in the provided collection.
`ElementSelector`	`find(String selector)`
`String`	`getAttribute(String key)` Gets an attribute value from the first item in this found set.
`boolean`	`getBoolean(String key, boolean defaultValue)` Gets a boolean value on this selector.
`ElementSelector`	`getChildAt(int index)`
`int`	`getChildIndex(Element child)`
`ElementSelector`	`getChildrenByTagName(String name)`
`Date`	`getDate(String key, DateFormat... formats)` Gets a date value on this selector.
`ElementSelector`	`getDescendantsByTagName(String name)`
`ElementSelector`	`getDescendantsByTagName(String name, int depth)`
`ElementSelector`	`getDescendantsByTagNameAndAttribute(String name, String tagName, int depth)`
`double`	`getDouble(String key, double defaultValue)` Gets a double value on this selector.
`ElementSelector`	`getElementById(String id)`
`ElementSelector`	`getFirstChildByTagName(String name)`
`int`	`getInt(String key, int defaultValue)` Gets an int value on this selector.
`int`	`getNumChildren()`
`ElementSelector`	`getParent()`
`String`	`getString(String key, String defaultValue)` Gets a string value on this selector.
`String`	`getText()`
`boolean`	`hasTextChild()`
`boolean`	`isEmpty()`
`Iterator<Element>`	`iterator()`
`boolean`	`remove(Object o)` Explicitly removes a component from the result set.
`boolean`	`removeAll(Collection<?> c)` Removes all of the components in the provided collection from the result set.
`ElementSelector`	`removeAttribute(String attribute)`
`ElementSelector`	`removeChildAt(int indx)`
`boolean`	`retainAll(Collection<?> c)` Retains only elements of the result set that are contained in the provided collection.
`ElementSelector`	`setAttribute(String key, String value)`
`ElementSelector`	`setBoolean(String key, boolean value)`
`ElementSelector`	`setDate(String key, Date date, DateFormat fmt)`
`ElementSelector`	`setDouble(String key, double value)`
`ElementSelector`	`setInt(String key, int value)`
`ElementSelector`	`setString(String key, String value)`
`int`	`size()` Returns number of results found.
`Object[]`	`toArray()` Returns results as an array.
`<T> T[]`	`toArray(T[] a)` Returns results as an array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Set
equals, hashCode, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - ElementSelector
```
public ElementSelector(String selector,
                       Set<Element> roots)
```
    Creates an element selector with the given selector on the provided roots.
    
    Parameters:
    
    selector - The selector.
    
    roots - The roots
  - ElementSelector
```
public ElementSelector(Set<Element> cmps)
```
    Creates a component selector that wraps the provided components. The provided components are treated as the "results" of this selector. Not the roots. However you can use find(java.lang.String) to perform a query using this selector as the roots.
    
    Parameters:
    
    cmps - Components to add to this selector results.
  - ElementSelector
```
public ElementSelector(Element... els)
```
    Creates a element selector that wraps the provided elements. The provided components are treated as the "results" of this selector. Not the roots. However you can use find(java.lang.String) to perform a query using this selector as the roots.
    
    Parameters:
    
    els - Components to add to this selector results.
  - ElementSelector
```
public ElementSelector(String selector,
                       Element... roots)
```
    Creates a selector with the provided roots. This will only search through the subtrees of the provided roots to find results that match the provided selector string.
    
    Parameters:
    
    selector - The selector string
    
    roots - The roots for this selector.
  - ElementSelector
```
public ElementSelector(String selector,
                       Collection<Element> roots)
```
    Creates a selector with the provided roots. This will only search through the subtrees of the provided roots to find results that match the provided selector string.
    
    Parameters:
    
    selector - The selector string
    
    roots - The roots for this selector.
- Method Detail
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Retains only elements of the result set that are contained in the provided collection.
    
    Specified by:
    
    retainAll in interface Collection<Element>
    
    Specified by:
    
    retainAll in interface Set<Element>
    
    Parameters:
    
    c -
    
    Returns:
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Removes all of the components in the provided collection from the result set.
    
    Specified by:
    
    removeAll in interface Collection<Element>
    
    Specified by:
    
    removeAll in interface Set<Element>
    
    Parameters:
    
    c -
    
    Returns:
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Element>
    
    Specified by:
    
    clear in interface Set<Element>
  - iterator
```
public Iterator<Element> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Element>
    
    Specified by:
    
    iterator in interface Collection<Element>
    
    Specified by:
    
    iterator in interface Set<Element>
  - size
```
public int size()
```
    Returns number of results found.
    
    Specified by:
    
    size in interface Collection<Element>
    
    Specified by:
    
    size in interface Set<Element>
    
    Returns:
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Element>
    
    Specified by:
    
    isEmpty in interface Set<Element>
    
    Returns:
    
    True if there were no results.
  - contains
```
public boolean contains(Object o)
```
    Checks if an object is contained in result set.
    
    Specified by:
    
    contains in interface Collection<Element>
    
    Specified by:
    
    contains in interface Set<Element>
    
    Parameters:
    
    o -
    
    Returns:
  - toArray
```
public Object[] toArray()
```
    Returns results as an array.
    
    Specified by:
    
    toArray in interface Collection<Element>
    
    Specified by:
    
    toArray in interface Set<Element>
    
    Returns:
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Returns results as an array.
    
    Specified by:
    
    toArray in interface Collection<Element>
    
    Specified by:
    
    toArray in interface Set<Element>
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    a -
    
    Returns:
  - add
```
public boolean add(Element e)
```
    Explicitly adds a component to the result set.
    
    Specified by:
    
    add in interface Collection<Element>
    
    Specified by:
    
    add in interface Set<Element>
    
    Parameters:
    
    e -
    
    Returns:
    
    True on success
  - append
```
public ElementSelector append(Element child)
```
    Appends a child component to the first container in this set. Same as calling Container#add(com.codename1.ui.Component) padding child on first container in this set.
    
    Parameters:
    
    child - Component to add to container.
    
    Returns:
    
    Self for chaining.
  - append
```
public ElementSelector append(Object constraint,
                              Element child)
```
    Appends a child component to the first container in this set. Same as calling Container#add(java.lang.Object, com.codename1.ui.Component) padding child on first container in this set.
    
    Parameters:
    
    constraint -
    
    child -
    
    Returns:
  - setAttribute
```
public ElementSelector setAttribute(String key,
                                    String value)
```
  - getAttribute
```
public String getAttribute(String key)
```
    Gets an attribute value from the first item in this found set.
    
    Parameters:
    
    key -
    
    Returns:
  - setString
```
public ElementSelector setString(String key,
                                 String value)
```
  - setInt
```
public ElementSelector setInt(String key,
                              int value)
```
  - setDouble
```
public ElementSelector setDouble(String key,
                                 double value)
```
  - setBoolean
```
public ElementSelector setBoolean(String key,
                                  boolean value)
```
  - setDate
```
public ElementSelector setDate(String key,
                               Date date,
                               DateFormat fmt)
```
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Gets a string value on this selector. This uses a notation that allows you to target the current result, or a subselection.
    
    Parameters:
    
    key - The key. E.g. "@attname" for attribute. "tagname" for subtag. "subselector/@attname", "subselector/tagname"
    
    defaultValue - The default value if no value is found.
    
    Returns:
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Gets an int value on this selector. This uses a notation that allows you to target the current result, or a subselection.
    
    Parameters:
    
    key - The key. E.g. "@attname" for attribute. "tagname" for subtag. "subselector/@attname", "subselector/tagname"
    
    defaultValue - The default value if no value is found.
    
    Returns:
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Gets a double value on this selector. This uses a notation that allows you to target the current result, or a subselection.
    
    Parameters:
    
    key - The key. E.g. "@attname" for attribute. "tagname" for subtag. "subselector/@attname", "subselector/tagname"
    
    defaultValue - The default value if no value is found.
    
    Returns:
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Gets a boolean value on this selector. This uses a notation that allows you to target the current result, or a subselection.
    
    Parameters:
    
    key - The key. E.g. "@attname" for attribute. "tagname" for subtag. "subselector/@attname", "subselector/tagname"
    
    defaultValue - The default value if no value is found.
    
    Returns:
  - getDate
```
public Date getDate(String key,
                    DateFormat... formats)
```
    Gets a date value on this selector. This uses a notation that allows you to target the current result, or a subselection.
    
    Parameters:
    
    key - The key. E.g. "@attname" for attribute. "tagname" for subtag. "subselector/@attname", "subselector/tagname"
    
    formats - DateFormats to attempt to parse date with.
    
    Returns:
  - remove
```
public boolean remove(Object o)
```
    Explicitly removes a component from the result set.
    
    Specified by:
    
    remove in interface Collection<Element>
    
    Specified by:
    
    remove in interface Set<Element>
    
    Parameters:
    
    o -
    
    Returns:
    
    Self for chaining.
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Checks if the result set contains all of the components found in the provided collection.
    
    Specified by:
    
    containsAll in interface Collection<Element>
    
    Specified by:
    
    containsAll in interface Set<Element>
    
    Parameters:
    
    c -
    
    Returns:
  - addAll
```
public boolean addAll(Collection<? extends Element> c)
```
    Adds all components in the given collection to the result set.
    
    Specified by:
    
    addAll in interface Collection<Element>
    
    Specified by:
    
    addAll in interface Set<Element>
    
    Parameters:
    
    c -
    
    Returns:
  - getChildAt
```
public ElementSelector getChildAt(int index)
```
  - getParent
```
public ElementSelector getParent()
```
  - getChildIndex
```
public int getChildIndex(Element child)
```
  - getChildrenByTagName
```
public ElementSelector getChildrenByTagName(String name)
```
  - getDescendantsByTagName
```
public ElementSelector getDescendantsByTagName(String name,
                                               int depth)
```
  - getDescendantsByTagName
```
public ElementSelector getDescendantsByTagName(String name)
```
  - getDescendantsByTagNameAndAttribute
```
public ElementSelector getDescendantsByTagNameAndAttribute(String name,
                                                           String tagName,
                                                           int depth)
```
  - getElementById
```
public ElementSelector getElementById(String id)
```
  - getFirstChildByTagName
```
public ElementSelector getFirstChildByTagName(String name)
```
  - getNumChildren
```
public int getNumChildren()
```
  - getText
```
public String getText()
```
  - hasTextChild
```
public boolean hasTextChild()
```
  - removeAttribute
```
public ElementSelector removeAttribute(String attribute)
```
  - removeChildAt
```
public ElementSelector removeChildAt(int indx)
```
  - find
```
public ElementSelector find(String selector)
```

Class ElementSelector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

ElementSelector

ElementSelector

ElementSelector

ElementSelector

ElementSelector

Method Detail

retainAll

removeAll

clear

iterator

size

isEmpty

contains

toArray

toArray

add

append

append

setAttribute

getAttribute

setString

setInt

setDouble

setBoolean

setDate

getString

getInt

getDouble

getBoolean

getDate

remove

containsAll

addAll

getChildAt

getParent

getChildIndex

getChildrenByTagName

getDescendantsByTagName

getDescendantsByTagName

getDescendantsByTagNameAndAttribute

getElementById

getFirstChildByTagName

getNumChildren

getText

hasTextChild

removeAttribute

removeChildAt

find