com.gargoylesoftware.htmlunit.html
Class HtmlInput

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          com.gargoylesoftware.htmlunit.html.HtmlElement
              com.gargoylesoftware.htmlunit.html.StyledElement
                  com.gargoylesoftware.htmlunit.html.ClickableElement
                      com.gargoylesoftware.htmlunit.html.FocusableElement
                          com.gargoylesoftware.htmlunit.html.HtmlInput

All Implemented Interfaces:

DisabledElement, SubmittableElement, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

HtmlButtonInput, HtmlCheckBoxInput, HtmlFileInput, HtmlHiddenInput, HtmlImageInput, HtmlPasswordInput, HtmlRadioButtonInput, HtmlResetInput, HtmlSubmitInput, HtmlTextInput

public abstract class HtmlInput
extends FocusableElement
implements DisabledElement, SubmittableElement

Wrapper for the html element "input"

Version:

$Revision: 1.3 $

Author:

Mike Bowler, David K. Taylor, Christian Sell, David D. Kilzer, Marc Guillemot, Daniel Gredler, Ahmed Ashour

See Also:

Serialized Form

Nested Class Summary

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

HtmlElement.MapEntryWrappingIterator

Field Summary

static java.lang.String

TAG_NAME the HTML tag represented by this element

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

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

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

PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Constructor Summary

HtmlInput(HtmlPage page, java.util.Map attributes)
Create an instance

HtmlInput(java.lang.String namespaceURI, java.lang.String qualifiedName, HtmlPage page, java.util.Map attributes)
Create an instance

Method Summary

java.lang.String	asText() Returns a text representation of this element that represents what would be visible to the user if this page was shown in a web browser.
Page	click(int x, int y) Simulate clicking this input with a pointing device.
java.lang.String	getAcceptAttribute() Return the value of the attribute "accept".
java.lang.String	getAccessKeyAttribute() Return the value of the attribute "accesskey".
java.lang.String	getAlignAttribute() Return the value of the attribute "align".
java.lang.String	getAltAttribute() Return the value of the attribute "alt".
java.lang.String	getCheckedAttribute() Return the value of the attribute "checked".
java.lang.String	getDefaultValue() Returns the default value to use when this element gets reset, if applicable.
java.lang.String	getDisabledAttribute() Return the value of the attribute "disabled".
java.lang.String	getMaxLengthAttribute() Return the value of the attribute "maxlength".
java.lang.String	getNameAttribute() Return the value of the attribute "name".
java.lang.String	getOnBlurAttribute() Return the value of the attribute "onblur".
java.lang.String	getOnChangeAttribute() Return the value of the attribute "onchange".
java.lang.String	getOnFocusAttribute() Return the value of the attribute "onfocus".
java.lang.String	getOnSelectAttribute() Return the value of the attribute "onselect".
java.lang.String	getReadOnlyAttribute() Return the value of the attribute "readonly".
java.lang.String	getSizeAttribute() Return the value of the attribute "size".
java.lang.String	getSrcAttribute() Return the value of the attribute "src".
KeyValuePair[]	getSubmitKeyValuePairs() Return an array of KeyValuePairs that are the values that will be sent back to the server whenever the current form is submitted.
java.lang.String	getTabIndexAttribute() Return the value of the attribute "tabindex".
java.lang.String	getTypeAttribute() Return the value of the attribute "type".
java.lang.String	getUseMapAttribute() Return the value of the attribute "usemap".
java.lang.String	getValueAttribute() Return the value of the attribute "value".
boolean	isChecked() Return true if this element is currently selected
boolean	isDefaultChecked() Returns the default checked state to use when this element gets reset, if applicable. The default implementation returns false; only checkboxes and radio buttons really care what the default checked value is.
boolean	isDisabled() Return true if the disabled attribute is set for this element.
void	reset() Return the value of this element to the default value or checked state (usually what it was at the time the page was loaded, unless it has been modified via JavaScript).
Page	setChecked(boolean isChecked) Set the "checked" attribute
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.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value to use when this element gets reset, if applicable. Also sets the value attribute when emulating Netscape browsers.
Page	setValueAttribute(java.lang.String newValue) Set the content of the "value" attribute, executing onchange handlers if appropriate.

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

blur, focus

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

click, click, dblClick, dblClick, getLangAttribute, getOnClickAttribute, getOnDblClickAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTextDirectionAttribute, getXmlLangAttribute

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

getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute

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

addHtmlAttributeChangeListener, appendChildIfNoneExists, cloneDomNode, fireEvent, fireEvent, getAttributeEntriesIterator, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTagName, hasHtmlElementWithId, isAttributeDefined, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeValue, setEventHandler, setEventHandler, setId, toString

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

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix

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

addDomChangeListener, appendDomChild, asXml, getAllHtmlChildElements, getByXPath, getChildIterator, getEndColumnNumber, getEndLineNumber, getFirstDomChild, getLastDomChild, getNextDomSibling, getNodeValue, getPage, getParentDomNode, getPreviousDomSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, remove, removeAllChildren, removeDomChangeListener, replace, setNodeValue, setReadyState, setScriptObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

the HTML tag represented by this element

See Also:

Constant Field Values

Constructor Detail

HtmlInput

public HtmlInput(HtmlPage page,
                 java.util.Map attributes)

Create an instance

Parameters:

page - The page that contains this element

attributes - the initial attributes

HtmlInput

public HtmlInput(java.lang.String namespaceURI,
                 java.lang.String qualifiedName,
                 HtmlPage page,
                 java.util.Map attributes)

Create an instance

Parameters:

namespaceURI - the URI that identifies an XML namespace.

qualifiedName - The qualified name of the element type to instantiate

page - The page that contains this element

attributes - the initial attributes

Method Detail

asText

public java.lang.String asText()

Returns a text 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:

The element as text.

click

public Page click(int x,
                  int y)
           throws java.io.IOException,
                  ElementNotFoundException

Simulate clicking this input with a pointing device. The x and y coordinates of the pointing device will be sent to the server.

Parameters:

x - The x coordinate of the pointing device at the time of clicking

y - The y coordinate of the pointing device at the time of clicking

Returns:

The page that is loaded after the click has taken place.

Throws:

java.io.IOException - If an io error occurs

ElementNotFoundException - If a particular xml element could not be found in the dom model

getAcceptAttribute

public final java.lang.String getAcceptAttribute()

Return the value of the attribute "accept". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "accept" or an empty string if that attribute isn't defined.

getAccessKeyAttribute

public final java.lang.String getAccessKeyAttribute()

Return the value of the attribute "accesskey". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "accesskey" or an empty string if that attribute isn't defined.

getAlignAttribute

public final java.lang.String getAlignAttribute()

Return the value of the attribute "align". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "align" or an empty string if that attribute isn't defined.

getAltAttribute

public final java.lang.String getAltAttribute()

Return the value of the attribute "alt". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "alt" or an empty string if that attribute isn't defined.

getCheckedAttribute

public final java.lang.String getCheckedAttribute()

Return the value of the attribute "checked". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "checked" or an empty string if that attribute isn't defined.

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value to use when this element gets reset, if applicable.

Specified by:

getDefaultValue in interface SubmittableElement

Returns:

the default value to use when this element gets reset, if applicable.

See Also:

SubmittableElement.getDefaultValue()

getDisabledAttribute

public final java.lang.String getDisabledAttribute()

Return the value of the attribute "disabled". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Specified by:

getDisabledAttribute in interface DisabledElement

Returns:

The value of the attribute "disabled" or an empty string if that attribute isn't defined.

getMaxLengthAttribute

public final java.lang.String getMaxLengthAttribute()

Return the value of the attribute "maxlength". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "maxlength" or an empty string if that attribute isn't defined.

getNameAttribute

public final java.lang.String getNameAttribute()

Return the value of the attribute "name". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "name" or an empty string if that attribute isn't defined.

getOnBlurAttribute

public final java.lang.String getOnBlurAttribute()

Return the value of the attribute "onblur". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "onblur" or an empty string if that attribute isn't defined.

getOnChangeAttribute

public final java.lang.String getOnChangeAttribute()

Return the value of the attribute "onchange". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "onchange" or an empty string if that attribute isn't defined.

getOnFocusAttribute

public final java.lang.String getOnFocusAttribute()

Return the value of the attribute "onfocus". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "onfocus" or an empty string if that attribute isn't defined.

getOnSelectAttribute

public final java.lang.String getOnSelectAttribute()

Return the value of the attribute "onselect". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "onselect" or an empty string if that attribute isn't defined.

getReadOnlyAttribute

public final java.lang.String getReadOnlyAttribute()

Return the value of the attribute "readonly". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "readonly" or an empty string if that attribute isn't defined.

getSizeAttribute

public final java.lang.String getSizeAttribute()

Return the value of the attribute "size". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "size" or an empty string if that attribute isn't defined.

getSrcAttribute

public final java.lang.String getSrcAttribute()

Return the value of the attribute "src". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "src" or an empty string if that attribute isn't defined.

getSubmitKeyValuePairs

public KeyValuePair[] getSubmitKeyValuePairs()

Return an array of KeyValuePairs that are the values that will be sent back to the server whenever the current 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:

getSubmitKeyValuePairs in interface SubmittableElement

Returns:

See above

getTabIndexAttribute

public final java.lang.String getTabIndexAttribute()

Return the value of the attribute "tabindex". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "tabindex" or an empty string if that attribute isn't defined.

getTypeAttribute

public final java.lang.String getTypeAttribute()

Return the value of the attribute "type". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "type" or an empty string if that attribute isn't defined.

getUseMapAttribute

public final java.lang.String getUseMapAttribute()

Return the value of the attribute "usemap". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "usemap" or an empty string if that attribute isn't defined.

getValueAttribute

public final java.lang.String getValueAttribute()

Return the value of the attribute "value". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "value" or an empty string if that attribute isn't defined

isChecked

public boolean isChecked()

Return true if this element is currently selected

Returns:

See above

isDefaultChecked

public boolean isDefaultChecked()

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

Specified by:

isDefaultChecked in interface SubmittableElement

Returns:

The default checked state to use when this element gets reset, if applicable.

See Also:

SubmittableElement.isDefaultChecked(), HtmlRadioButtonInput.isDefaultChecked(), HtmlCheckBoxInput.isDefaultChecked()

isDisabled

public final boolean isDisabled()

Return true if the disabled attribute is set for this element.

Specified by:

isDisabled in interface DisabledElement

Returns:

Return true if this is disabled.

reset

public void reset()

Return the value of this element to the default value or checked state (usually what it was at the time the page was loaded, unless it has been modified via JavaScript).

Specified by:

reset in interface SubmittableElement

See Also:

SubmittableElement.reset()

setChecked

public Page setChecked(boolean isChecked)

Set the "checked" attribute

Parameters:

isChecked - true if this element is to be selected

Returns:

The page that occupies this window after setting checked status. It may be the same window or it may be a freshly loaded one.

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)

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Sets the default value to use when this element gets reset, if applicable. Also sets the value attribute when emulating Netscape browsers.

Specified by:

setDefaultValue in interface SubmittableElement

Parameters:

defaultValue - The default value to use when this element gets reset, if applicable.

See Also:

SubmittableElement.setDefaultValue(String), HtmlFileInput.setDefaultValue(String)

setValueAttribute

public Page setValueAttribute(java.lang.String newValue)

Set the content of the "value" attribute, executing onchange handlers if appropriate.

Parameters:

newValue - The new content

Returns:

the page that occupies this window after this value is set. It may be the same window or it may be a freshly loaded one.