com.gargoylesoftware.htmlunit.html
Class HtmlInput

java.lang.Object
  extended by com.gargoylesoftware.htmlunit.html.DomNode
      extended by com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          extended by com.gargoylesoftware.htmlunit.html.DomElement
              extended by com.gargoylesoftware.htmlunit.html.HtmlElement
                  extended by com.gargoylesoftware.htmlunit.html.StyledElement
                      extended by com.gargoylesoftware.htmlunit.html.ClickableElement
                          extended by com.gargoylesoftware.htmlunit.html.FocusableElement
                              extended by com.gargoylesoftware.htmlunit.html.HtmlInput
All Implemented Interfaces:
DisabledElement, SubmittableElement, Serializable, 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: 2132 $
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.ChildElementsIterator, HtmlElement.MapEntryWrappingIterator
 
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode
DomNode.ChildIterator, DomNode.DescendantElementsIterator
 
Field Summary
static 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, TAB_INDEX_OUT_OF_BOUNDS
 
Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode
ATTRIBUTE_NODE, COMMENT_NODE, DOCUMENT_NODE, ELEMENT_NODE, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED, TEXT_NODE
 
Constructor Summary
HtmlInput(HtmlPage page, Map attributes)
          Create an instance
HtmlInput(String namespaceURI, String qualifiedName, HtmlPage page, Map attributes)
          Create an instance
 
Method Summary
 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.
 String getAcceptAttribute()
          Return the value of the attribute "accept".
 String getAccessKeyAttribute()
          Return the value of the attribute "accesskey".
 String getAlignAttribute()
          Return the value of the attribute "align".
 String getAltAttribute()
          Return the value of the attribute "alt".
 String getCheckedAttribute()
          Return the value of the attribute "checked".
 String getDefaultValue()
          Returns the default value to use when this element gets reset, if applicable.
 String getDisabledAttribute()
          Return the value of the attribute "disabled".
 String getMaxLengthAttribute()
          Return the value of the attribute "maxlength".
 String getNameAttribute()
          Return the value of the attribute "name".
 String getOnBlurAttribute()
          Return the value of the attribute "onblur".
 String getOnChangeAttribute()
          Return the value of the attribute "onchange".
 String getOnFocusAttribute()
          Return the value of the attribute "onfocus".
 String getOnSelectAttribute()
          Return the value of the attribute "onselect".
 String getReadOnlyAttribute()
          Return the value of the attribute "readonly".
 String getSizeAttribute()
          Return the value of the attribute "size".
 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.
 String getTabIndexAttribute()
          Return the value of the attribute "tabindex".
 String getTypeAttribute()
          Return the value of the attribute "type".
 String getUseMapAttribute()
          Return the value of the attribute "usemap".
 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(String defaultValue)
          Sets the default value to use when this element gets reset, if applicable. Also sets the value attribute when emulating Netscape browsers.
protected  void setDefaultValue(String defaultValue, boolean modifyValue)
          Sets the default value, optionally also modifying the current value.
 Page setValueAttribute(String newValue)
          Set the content of the "value" attribute, executing onchange handlers if appropriate.
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.ClickableElement
click, click, click, dblClick, dblClick, doClickAction, getLangAttribute, getOnClickAttribute, getOnDblClickAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTextDirectionAttribute, getXmlLangAttribute, isStateUpdateFirst
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.StyledElement
getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute, isRenderedVisible
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
addHtmlAttributeChangeListener, appendChildIfNoneExists, assertNotEmpty, blur, cloneDomNode, cloneNode, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getAttribute, getAttributeEntriesIterator, getAttributeNS, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTabIndex, getTagName, hasAttribute, hasAttributeNS, hasAttributes, hasHtmlElementWithId, isAttributeDefined, isEmptyXmlTagExpanded, isSubmittableByEnter, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, notImplemented, preventDefault, printOpeningTagContentAsXml, printXml, removeAttribute, removeAttributeNS, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttribute, setAttributeNS, setAttributeValue, setAttributeValue, setEventHandler, setEventHandler, setId, toString, type, type, type, type
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode
addDomChangeListener, addPropertyChangeListener, appendChild, appendDomChild, asXml, fireNodeAdded, fireNodeDeleted, firePropertyChange, getAllHtmlChildElements, getByXPath, getChildIterator, getChildrenAsText, getEndColumnNumber, getEndLineNumber, getFirstByXPath, getFirstChild, getFirstDomChild, getLastChild, getLastDomChild, getLog, getNativePage, getNextDomSibling, getNextSibling, getNodeValue, getPage, getParentDomNode, getParentNode, getPreviousDomSibling, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, isAncestorOf, isTrimmedText, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, reduceWhitespace, remove, removeAllChildren, removeDomChangeListener, removePropertyChangeListener, replace, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TAG_NAME

public static final String TAG_NAME
the HTML tag represented by this element

See Also:
Constant Field Values
Constructor Detail

HtmlInput

public HtmlInput(HtmlPage page,
                 Map attributes)
Create an instance

Parameters:
page - The page that contains this element
attributes - the initial attributes

HtmlInput

public HtmlInput(String namespaceURI,
                 String qualifiedName,
                 HtmlPage page,
                 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

setValueAttribute

public Page setValueAttribute(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.

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

asText

public 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.

getTypeAttribute

public final 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.

getNameAttribute

public final 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.

getValueAttribute

public final 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

getCheckedAttribute

public final 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.

getDisabledAttribute

public final 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.

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.

getReadOnlyAttribute

public final 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 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.

getMaxLengthAttribute

public final 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.

getSrcAttribute

public final 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.

getAltAttribute

public final 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.

getUseMapAttribute

public final 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.

getTabIndexAttribute

public final 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.

getAccessKeyAttribute

public final 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.

getOnFocusAttribute

public final 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.

getOnBlurAttribute

public final 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.

getOnSelectAttribute

public final 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.

getOnChangeAttribute

public final 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.

getAcceptAttribute

public final 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.

getAlignAttribute

public final 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.

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()

setDefaultValue

public void setDefaultValue(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)

setDefaultValue

protected void setDefaultValue(String defaultValue,
                               boolean modifyValue)
Sets the default value, optionally also modifying the current value.

Parameters:
defaultValue - The new default value.
modifyValue - Whether or not to set the current value to the default value.

getDefaultValue

public 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()

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)

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()

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.

isChecked

public boolean isChecked()
Return true if this element is currently selected

Returns:
See above

click

public Page click(int x,
                  int y)
           throws 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:
IOException - If an io error occurs
ElementNotFoundException - If a particular xml element could not be found in the dom model


Copyright © 2002-2010 Gargoyle Software Inc.. All Rights Reserved.