com.gargoylesoftware.htmlunit.html

Class HtmlFileInput

java.lang.Object

com.gargoylesoftware.htmlunit.html.DomNode

com.gargoylesoftware.htmlunit.html.DomNamespaceNode

com.gargoylesoftware.htmlunit.html.DomElement

com.gargoylesoftware.htmlunit.html.HtmlElement

com.gargoylesoftware.htmlunit.html.HtmlInput

com.gargoylesoftware.htmlunit.html.HtmlFileInput

All Implemented Interfaces:

DisabledElement, FormFieldWithNameHistory, LabelableElement, SubmittableElement, Serializable, Cloneable, Element, Node

public class HtmlFileInput
extends HtmlInput
implements LabelableElement

Wrapper for the HTML element "input".

Author:

Mike Bowler, Christian Sell, Daniel Gredler, Ahmed Ashour, Marc Guillemot, Frank Danek, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

HtmlElement.DisplayStyle

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomElement

DomElement.ChildElementsIterator

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlInput

TAG_NAME

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

TAB_INDEX_OUT_OF_BOUNDS

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomElement

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, SRC_ATTRIBUTE

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Modifier and Type	Method and Description
String	asText() Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser.
String	getContentType() Gets the content type that should be sent together with the uploaded file.
byte[]	getData() Returns the in-memory data assigned to this file input element, if any.
File[]	getFiles() Returns the files.
NameValuePair[]	getSubmitNameValuePairs() Returns an array of NameValuePairs that are the values that will be sent back to the server whenever this element's containing form is submitted.
boolean	isValid() Returns whether this element satisfies all form validation constraints set.
void	setContentType(String contentType) Sets the content type value that should be sent together with the uploaded file.
void	setData(byte[] data) Assigns in-memory data to this file input element.
void	setDefaultChecked(boolean defaultChecked) Sets the default checked state to use when this element gets reset, if applicable.
void	setFiles(File... files) Used to specify multiple files to upload.
void	setValueAttribute(String newValue) Sets the content of the value attribute.

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlInput

cloneNode, focus, getAccept, getAcceptAttribute, getAccessKeyAttribute, getAlignAttribute, getAltAttribute, getAutocomplete, getCheckedAttribute, getDefaultStyleDisplay, getDefaultValue, getDisabledAttribute, getMaxLength, getMaxLengthAttribute, getNameAttribute, getNewNames, getOnBlurAttribute, getOnChangeAttribute, getOnFocusAttribute, getOnSelectAttribute, getOriginalName, getPlaceholder, getReadOnlyAttribute, getSize, getSizeAttribute, getSrcAttribute, getTabIndexAttribute, getTypeAttribute, getUseMapAttribute, getValueAttribute, handles, isChecked, isDefaultChecked, isDisabled, isReadOnly, isRequiredSupported, markAsCreatedByJavascript, propagateClickStateUpdateToParent, removeFocus, reset, setAccept, setAttribute, setAttributeNS, setAutocomplete, setChecked, setDefaultValue, setDefaultValue, setMaxLength, setMinLength, setPlaceholder, setReadOnly, setSize, wasCreatedByJavascript

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, doType, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isDisplayed, isHidden, isRequired, isShiftPressed, isSubmittableByEnter, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setRequired, type, type, type, type, typeDone

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement

blur, click, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, getAttribute, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isEmptyXmlTagExpanded, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, printXml, removeAttributeNode, removeAttributeNS, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttributeNodeNS, setAttributeNS, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, toString, writeStyleToElement

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode

getLocalName, getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addCharacterDataChangeListener, addDomChangeListener, appendChild, asXml, basicRemove, compareDocumentPosition, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextElementSibling, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousElementSibling, getPreviousSibling, getReadyState, getScriptableObject, getSelectorList, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, getVisibleText, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setNextSibling, setParentNode, setPreviousSibling, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserData

Method Detail

getData

public final byte[] getData()

Returns the in-memory data assigned to this file input element, if any.

Returns:

null if setData(byte[]) hasn't be used

setData

public final void setData(byte[] data)

Assigns in-memory data to this file input element. During submission, instead of loading data from a file, the data is read from in-memory byte array.

NOTE: Only use this method if you wish to upload in-memory data; if you instead wish to upload the contents of an actual file, use setValueAttribute(String), passing in the path to the file.

Parameters:

data - the in-memory data assigned to this file input element

setDefaultChecked

public void setDefaultChecked(boolean defaultChecked)

Sets the default checked state to use when this element gets reset, if applicable. The default implementation is empty; only checkboxes and radio buttons really care what the default checked value is.

Specified by:

setDefaultChecked in interface SubmittableElement

Parameters:

defaultChecked - the default checked state to use when this element gets reset, if applicable

See Also:

SubmittableElement.setDefaultChecked(boolean), HtmlRadioButtonInput.setDefaultChecked(boolean), HtmlCheckBoxInput.setDefaultChecked(boolean)

getSubmitNameValuePairs

public NameValuePair[] getSubmitNameValuePairs()

Returns an array of NameValuePairs that are the values that will be sent back to the server whenever this element's containing form is submitted.

THIS METHOD IS INTENDED FOR THE USE OF THE FRAMEWORK ONLY AND SHOULD NOT BE USED BY CONSUMERS OF HTMLUNIT. USE AT YOUR OWN RISK.

Specified by:

getSubmitNameValuePairs in interface SubmittableElement

Overrides:

getSubmitNameValuePairs in class HtmlInput

Returns:

the values that will be sent back to the server whenever this element's containing form is submitted

setContentType

public void setContentType(String contentType)

Sets the content type value that should be sent together with the uploaded file. If content type is not explicitly set, HtmlUnit will try to guess it from the file content.

Parameters:

contentType - the content type (null resets it)

getContentType

public String getContentType()

Gets the content type that should be sent together with the uploaded file.

Returns:

the content type, or null if this has not been explicitly set and should be guessed from file content

asText

public String asText()

Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser. For example, a single-selection select element would return the currently selected value as text.

Overrides:

asText in class DomNode

Returns:

a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser

setValueAttribute

public void setValueAttribute(String newValue)

Sets the content of the value attribute.

Overrides:

setValueAttribute in class HtmlInput

Parameters:

newValue - the new value

setFiles

public void setFiles(File... files)

Used to specify multiple files to upload. We may follow WebDriver solution, once made, see https://code.google.com/p/selenium/issues/detail?id=2239

Parameters:

files - the list of files to upload

getFiles

public File[] getFiles()

Returns the files.

Returns:

the array of Files

isValid

public boolean isValid()

Returns whether this element satisfies all form validation constraints set.

Overrides:

isValid in class HtmlElement

Returns:

whether this element satisfies all form validation constraints set