com.teamdev.jxbrowser.dom

Interface SearchContext

All Known Subinterfaces:

Document, Element, FormControlElement, FormElement, FrameElement, InputElement, Node, OptionElement, SelectElement, TextAreaElement

public interface SearchContext

Base interface for search methods that must be inherited by the DOM interfaces that want to have search mechanisms.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Element>	findElementByClassName(java.lang.String className) Returns the first Element object found in the current search context by the given className.
java.util.Optional<Element>	findElementByCssSelector(java.lang.String cssSelector) Returns the first Element object found in the current search context by the given cssSelector.
java.util.Optional<Element>	findElementById(java.lang.String id) Returns the first Element object found in the current search context by the given id.
java.util.Optional<Element>	findElementByName(java.lang.String name) Returns the first Element object found in the current search context by the given name.
java.util.Optional<Element>	findElementByTagName(java.lang.String tagName) Returns the first Element object found in the current search context by the given tagName.
java.util.List<Element>	findElementsByClassName(java.lang.String className) Returns an immutable list of the Element objects found in the current search context by the given className.
java.util.List<Element>	findElementsByCssSelector(java.lang.String cssSelector) Returns an immutable list of the Element objects found in the current search context by the given cssSelector.
java.util.List<Element>	findElementsById(java.lang.String id) Returns an immutable list of the Element objects found in the current search context by the given id.
java.util.List<Element>	findElementsByName(java.lang.String name) Returns an immutable list of the Element objects found in the current search context by the given name.
java.util.List<Element>	findElementsByTagName(java.lang.String tagName) Returns an immutable list of the Element objects found in the current search context by the given tagName.

Method Detail

findElementsByClassName

java.util.List<Element> findElementsByClassName(java.lang.String className)

Returns an immutable list of the Element objects found in the current search context by the given className. Returns an empty list if no elements were found.

Parameters:

className - a string that represents the class attribute of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given className is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementsByCssSelector

java.util.List<Element> findElementsByCssSelector(java.lang.String cssSelector)

Returns an immutable list of the Element objects found in the current search context by the given cssSelector. Returns an empty list if no elements were found.

Parameters:

cssSelector - a string that represents the CSS selector

Throws:

java.lang.IllegalArgumentException - if the given cssSelector is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementsById

java.util.List<Element> findElementsById(java.lang.String id)

Returns an immutable list of the Element objects found in the current search context by the given id. Returns an empty list if no elements were found.

Parameters:

id - a string that represents the id attribute of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given id is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementsByName

java.util.List<Element> findElementsByName(java.lang.String name)

Returns an immutable list of the Element objects found in the current search context by the given name. Returns an empty list if no elements were found.

Parameters:

name - a string that represents the name attribute of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given name is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementsByTagName

java.util.List<Element> findElementsByTagName(java.lang.String tagName)

Returns an immutable list of the Element objects found in the current search context by the given tagName. Returns an empty list if no elements were found.

Parameters:

tagName - a string that represents the tag name of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given tagName is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementByClassName

java.util.Optional<Element> findElementByClassName(java.lang.String className)

Returns the first Element object found in the current search context by the given className. Returns an empty Optional if no element was found.

Parameters:

className - a string that represents the class attribute of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given className is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementByCssSelector

java.util.Optional<Element> findElementByCssSelector(java.lang.String cssSelector)

Returns the first Element object found in the current search context by the given cssSelector. Returns an empty Optional if no element was found.

Parameters:

cssSelector - a string that represents the CSS selector

Throws:

java.lang.IllegalArgumentException - if the given cssSelector is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementById

java.util.Optional<Element> findElementById(java.lang.String id)

Returns the first Element object found in the current search context by the given id. Returns an empty Optional if no element was found.

Parameters:

id - a string that represents the id attribute of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given id is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementByName

java.util.Optional<Element> findElementByName(java.lang.String name)

Returns the first Element object found in the current search context by the given name. Returns an empty Optional if no element was found.

Parameters:

name - a string that represents the name attribute of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given name is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed

findElementByTagName

java.util.Optional<Element> findElementByTagName(java.lang.String tagName)

Returns the first Element object found in the current search context by the given tagName. Returns an empty Optional if no element was found.

Parameters:

tagName - a string that represents the tag name of the HTML element

Throws:

java.lang.IllegalArgumentException - if the given tagName is empty

java.lang.IllegalStateException - when the document this instance belongs to is closed