com.teamdev.jxbrowser.dom

Interface InputElement

All Superinterfaces:

Element, EventTarget, FormControlElement, Node, SearchContext

public interface InputElement
extends FormControlElement

An HTML DOM input element.

Provides access to the attributes of the input element.

Nested Class Summary

Nested classes/interfaces inherited from interface com.teamdev.jxbrowser.dom.Element

Element.AlignTo

Method Summary

Modifier and Type	Method and Description
void	check() Sets the checked attribute of the input DOM element with the type 'checkbox' or 'radio' to true.
java.lang.String	file() Returns a string that represents an absolute or relative path to a file if the current input DOM element has the type attribute with the 'file' value.
void	file(java.lang.String... filePaths) Sets one or multiple string values that represent the path to a file.
java.util.Collection<java.lang.String>	files() Returns an immutable collection of the file paths if the input type is 'file' or an empty collection if the input does not have a value.
boolean	isCheckbox() Returns true if the DOM element's type attribute has the 'checkbox' value.
boolean	isChecked() Returns true if the input DOM element with the type 'checkbox' or 'radio' is selected.
boolean	isEmailField() Returns true if the DOM element's type attribute has the 'email' value.
boolean	isFile() Returns true if the DOM element's type attribute has the 'file' value.
boolean	isMultipleFile() Returns true if the input DOM element has both the type attribute with the 'file' value, and the multiple attribute.
boolean	isPasswordField() Returns true if the DOM element's type attribute has the 'password' value.
boolean	isRadioButton() Returns true if the DOM element's type attribute has the 'radio' value.
boolean	isText() Returns true when isTextField() returns true and the type attribute value of the input HTML element is 'number'.
boolean	isTextField() Returns true if the DOM element's type attribute has the 'text' value.
void	uncheck() Sets the checked attribute of the input DOM element with the type 'checkbox' or 'radio' to false.

Methods inherited from interface com.teamdev.jxbrowser.dom.FormControlElement

form, isEnabled, value, value

Methods inherited from interface com.teamdev.jxbrowser.dom.Element

attributeNodes, attributes, attributeValue, blur, boundingClientRect, focus, hasAttribute, innerHtml, innerHtml, innerText, innerText, outerHtml, outerHtml, putAttribute, removeAttribute, scrollIntoView

Methods inherited from interface com.teamdev.jxbrowser.dom.Node

appendChild, children, click, compareDocumentPosition, document, evaluate, evaluate, insertChild, nextSibling, nodeName, nodeValue, nodeValue, parent, previousSibling, removeChild, replaceChild, textContent, textContent, type, xPath

Methods inherited from interface com.teamdev.jxbrowser.dom.event.EventTarget

addEventListener, dispatch, eventListeners, removeEventListener

Methods inherited from interface com.teamdev.jxbrowser.dom.SearchContext

findElementByClassName, findElementByCssSelector, findElementById, findElementByName, findElementByTagName, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByName, findElementsByTagName

Method Detail

isText

boolean isText()

Returns true when isTextField() returns true and the type attribute value of the input HTML element is 'number'.

Throws:

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

isCheckbox

boolean isCheckbox()

Returns true if the DOM element's type attribute has the 'checkbox' value. When the return value is true, the checked state of the DOM element can be retrieved with the isChecked() method and changed with the check() or uncheck() methods.

Throws:

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

isRadioButton

boolean isRadioButton()

Returns true if the DOM element's type attribute has the 'radio' value.

Throws:

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

isTextField

boolean isTextField()

Returns true if the DOM element's type attribute has the 'text' value.

Throws:

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

isEmailField

boolean isEmailField()

Returns true if the DOM element's type attribute has the 'email' value.

Throws:

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

isPasswordField

boolean isPasswordField()

Returns true if the DOM element's type attribute has the 'password' value.

Throws:

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

isFile

boolean isFile()

Returns true if the DOM element's type attribute has the 'file' value.

Throws:

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

isMultipleFile

boolean isMultipleFile()

Returns true if the input DOM element has both the type attribute with the 'file' value, and the multiple attribute. For example: <input type="file" multiple>.

Throws:

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

file

java.lang.String file()

Returns a string that represents an absolute or relative path to a file if the current input DOM element has the type attribute with the 'file' value. If this DOM element has the multiple attribute, returns string that represents the first of file paths. Returns an empty string if the element does not have a file selected.

Throws:

java.lang.IllegalStateException - when the type attribute value of the element is not 'file'

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

file

void file(java.lang.String... filePaths)

Sets one or multiple string values that represent the path to a file. This method can be used only when the input DOM element with the type has the 'file' value.

Parameters:

filePaths - the list of strings that represent the paths to the files

Throws:

java.lang.IllegalArgumentException - when one or more elements of the filePaths are empty or blank

java.lang.IllegalStateException - when the type attribute value of the element is not 'file'

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

files

java.util.Collection<java.lang.String> files()

Returns an immutable collection of the file paths if the input type is 'file' or an empty collection if the input does not have a value.

Throws:

java.lang.IllegalStateException - when the type attribute value of the element is not 'file'

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

isChecked

boolean isChecked()

Returns true if the input DOM element with the type 'checkbox' or 'radio' is selected. Use this method only with input elements with type 'checkbox' or 'radio'.

Throws:

java.lang.IllegalStateException - when the type attribute value of the element is not 'checkbox' or 'radio'

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

check

void check()

Sets the checked attribute of the input DOM element with the type 'checkbox' or 'radio' to true.

Throws:

java.lang.IllegalStateException - when the type attribute value of the element is not 'checkbox' or 'radio'

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

uncheck

void uncheck()

Sets the checked attribute of the input DOM element with the type 'checkbox' or 'radio' to false.

Throws:

java.lang.IllegalStateException - when the type attribute value of the element is not 'checkbox' or 'radio'

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