Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.w3c.dom.html2

Interface HTMLInputElement

All Superinterfaces:
Element, HTMLElement, Node
Known Implementing Classes:
DomHTMLInputElement
public interface HTMLInputElement
extends HTMLElement
Form control.Depending upon the environment in which the page is being viewed, the value property may be read-only for the file upload input type. For the "password" input type, the actual value returned may be masked to prevent unauthorized use. See the INPUT element definition in [HTML 4.01].

See also the Document Object Model (DOM) Level 2 HTML Specification.

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

void
blur()
Removes keyboard focus from this element.
void
click()
Simulate a mouse-click.
void
focus()
Gives keyboard focus to this element.
String
getAccept()
A comma-separated list of content types that a server processing this form will handle correctly.
String
getAccessKey()
A single character access key to give access to the form control.
String
getAlign()
Aligns this object (vertically or horizontally) with respect to its surrounding text.
String
getAlt()
Alternate text for user agents not rendering the normal content of this element.
boolean
getChecked()
When the type attribute of the element has the value "radio" or "checkbox", this represents the current state of the form control, in an interactive user agent.
boolean
getDefaultChecked()
When type has the value "radio" or "checkbox", this represents the HTML checked attribute of the element.
String
getDefaultValue()
When the type attribute of the element has the value "text", "file" or "password", this represents the HTML value attribute of the element.
boolean
getDisabled()
The control is unavailable in this context.
HTMLFormElement
getForm()
Returns the FORM element containing this control.
int
getMaxLength()
Maximum number of characters for text fields, when type has the value "text" or "password".
String
getName()
Form control or object name when submitted with a form.
boolean
getReadOnly()
This control is read-only.
int
getSize()
Size information.
String
getSrc()
When the type attribute has the value "image", this attribute specifies the location of the image to be used to decorate the graphical submit button.
int
getTabIndex()
Index that represents the element's position in the tabbing order.
String
getType()
The type of control created (all lower case).
String
getUseMap()
Use client-side image map.
String
getValue()
When the type attribute of the element has the value "text", "file" or "password", this represents the current contents of the corresponding form control, in an interactive user agent.
void
select()
Select the contents of the text area.
void
setAccept(String accept)
A comma-separated list of content types that a server processing this form will handle correctly.
void
setAccessKey(String accessKey)
A single character access key to give access to the form control.
void
setAlign(String align)
Aligns this object (vertically or horizontally) with respect to its surrounding text.
void
setAlt(String alt)
Alternate text for user agents not rendering the normal content of this element.
void
setChecked(boolean checked)
When the type attribute of the element has the value "radio" or "checkbox", this represents the current state of the form control, in an interactive user agent.
void
setDefaultChecked(boolean defaultChecked)
When type has the value "radio" or "checkbox", this represents the HTML checked attribute of the element.
void
setDefaultValue(String defaultValue)
When the type attribute of the element has the value "text", "file" or "password", this represents the HTML value attribute of the element.
void
setDisabled(boolean disabled)
The control is unavailable in this context.
void
setMaxLength(int maxLength)
Maximum number of characters for text fields, when type has the value "text" or "password".
void
setName(String name)
Form control or object name when submitted with a form.
void
setReadOnly(boolean readOnly)
This control is read-only.
void
setSize(int size)
Size information.
void
setSrc(String src)
When the type attribute has the value "image", this attribute specifies the location of the image to be used to decorate the graphical submit button.
void
setTabIndex(int tabIndex)
Index that represents the element's position in the tabbing order.
void
setType(String type)
The type of control created (all lower case).
void
setUseMap(String useMap)
Use client-side image map.
void
setValue(String value)
When the type attribute of the element has the value "text", "file" or "password", this represents the current contents of the corresponding form control, in an interactive user agent.

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNS, getAttributeNode, getAttributeNodeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNS, removeAttributeNode, setAttribute, setAttributeNS, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNS, setIdAttributeNode

Methods inherited from interface org.w3c.dom.html2.HTMLElement

getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle

Methods inherited from interface org.w3c.dom.Node

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

Method Details

blur

public void blur()
Removes keyboard focus from this element.

click

public void click()
Simulate a mouse-click. For INPUT elements whose type attribute has one of the following values: "button", "checkbox", "radio", "reset", or "submit".

focus

public void focus()
Gives keyboard focus to this element.

getAccept

public String getAccept()
A comma-separated list of content types that a server processing this form will handle correctly. See the accept attribute definition in HTML 4.01.

getAccessKey

public String getAccessKey()
A single character access key to give access to the form control. See the accesskey attribute definition in HTML 4.01.

getAlign

public String getAlign()
Aligns this object (vertically or horizontally) with respect to its surrounding text. See the align attribute definition in HTML 4.01. This attribute is deprecated in HTML 4.01.

getAlt

public String getAlt()
Alternate text for user agents not rendering the normal content of this element. See the alt attribute definition in HTML 4.01.

getChecked

public boolean getChecked()
When the type attribute of the element has the value "radio" or "checkbox", this represents the current state of the form control, in an interactive user agent. Changes to this attribute change the state of the form control, but do not change the value of the HTML checked attribute of the INPUT element.During the handling of a click event on an input element with a type attribute that has the value "radio" or "checkbox", some implementations may change the value of this property before the event is being dispatched in the document. If the default action of the event is canceled, the value of the property may be changed back to its original value. This means that the value of this property during the handling of click events is implementation dependent.

getDefaultChecked

public boolean getDefaultChecked()
When type has the value "radio" or "checkbox", this represents the HTML checked attribute of the element. The value of this attribute does not change if the state of the corresponding form control, in an interactive user agent, changes. See the checked attribute definition in HTML 4.01.

getDefaultValue

public String getDefaultValue()
When the type attribute of the element has the value "text", "file" or "password", this represents the HTML value attribute of the element. The value of this attribute does not change if the contents of the corresponding form control, in an interactive user agent, changes. See the value attribute definition in HTML 4.01.

getDisabled

public boolean getDisabled()
The control is unavailable in this context. See the disabled attribute definition in HTML 4.01.

getForm

public HTMLFormElement getForm()
Returns the FORM element containing this control. Returns null if this control is not within the context of a form.

getMaxLength

public int getMaxLength()
Maximum number of characters for text fields, when type has the value "text" or "password". See the maxlength attribute definition in HTML 4.01.

getName

public String getName()
Form control or object name when submitted with a form. See the name attribute definition in HTML 4.01.

getReadOnly

public boolean getReadOnly()
This control is read-only. Relevant only when type has the value "text" or "password". See the readonly attribute definition in HTML 4.01.

getSize

public int getSize()
Size information. The precise meaning is specific to each type of field. See the size attribute definition in HTML 4.01.

getSrc

public String getSrc()
When the type attribute has the value "image", this attribute specifies the location of the image to be used to decorate the graphical submit button. See the src attribute definition in HTML 4.01.

getTabIndex

public int getTabIndex()
Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.01.

getType

public String getType()
The type of control created (all lower case). See the type attribute definition in HTML 4.01.

getUseMap

public String getUseMap()
Use client-side image map. See the usemap attribute definition in HTML 4.01.

getValue

public String getValue()
When the type attribute of the element has the value "text", "file" or "password", this represents the current contents of the corresponding form control, in an interactive user agent. Changing this attribute changes the contents of the form control, but does not change the value of the HTML value attribute of the element. When the type attribute of the element has the value "button", "hidden", "submit", "reset", "image", "checkbox" or "radio", this represents the HTML value attribute of the element. See the value attribute definition in HTML 4.01.

select

public void select()
Select the contents of the text area. For INPUT elements whose type attribute has one of the following values: "text", "file", or "password".

setAccept

public void setAccept(String accept)
A comma-separated list of content types that a server processing this form will handle correctly. See the accept attribute definition in HTML 4.01.

setAccessKey

public void setAccessKey(String accessKey)
A single character access key to give access to the form control. See the accesskey attribute definition in HTML 4.01.

setAlign

public void setAlign(String align)
Aligns this object (vertically or horizontally) with respect to its surrounding text. See the align attribute definition in HTML 4.01. This attribute is deprecated in HTML 4.01.

setAlt

public void setAlt(String alt)
Alternate text for user agents not rendering the normal content of this element. See the alt attribute definition in HTML 4.01.

setChecked

public void setChecked(boolean checked)
When the type attribute of the element has the value "radio" or "checkbox", this represents the current state of the form control, in an interactive user agent. Changes to this attribute change the state of the form control, but do not change the value of the HTML checked attribute of the INPUT element.During the handling of a click event on an input element with a type attribute that has the value "radio" or "checkbox", some implementations may change the value of this property before the event is being dispatched in the document. If the default action of the event is canceled, the value of the property may be changed back to its original value. This means that the value of this property during the handling of click events is implementation dependent.

setDefaultChecked

public void setDefaultChecked(boolean defaultChecked)
When type has the value "radio" or "checkbox", this represents the HTML checked attribute of the element. The value of this attribute does not change if the state of the corresponding form control, in an interactive user agent, changes. See the checked attribute definition in HTML 4.01.

setDefaultValue

public void setDefaultValue(String defaultValue)
When the type attribute of the element has the value "text", "file" or "password", this represents the HTML value attribute of the element. The value of this attribute does not change if the contents of the corresponding form control, in an interactive user agent, changes. See the value attribute definition in HTML 4.01.

setDisabled

public void setDisabled(boolean disabled)
The control is unavailable in this context. See the disabled attribute definition in HTML 4.01.

setMaxLength

public void setMaxLength(int maxLength)
Maximum number of characters for text fields, when type has the value "text" or "password". See the maxlength attribute definition in HTML 4.01.

setName

public void setName(String name)
Form control or object name when submitted with a form. See the name attribute definition in HTML 4.01.

setReadOnly

public void setReadOnly(boolean readOnly)
This control is read-only. Relevant only when type has the value "text" or "password". See the readonly attribute definition in HTML 4.01.

setSize

public void setSize(int size)
Size information. The precise meaning is specific to each type of field. See the size attribute definition in HTML 4.01.

setSrc

public void setSrc(String src)
When the type attribute has the value "image", this attribute specifies the location of the image to be used to decorate the graphical submit button. See the src attribute definition in HTML 4.01.

setTabIndex

public void setTabIndex(int tabIndex)
Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.01.

setType

public void setType(String type)
The type of control created (all lower case). See the type attribute definition in HTML 4.01.

setUseMap

public void setUseMap(String useMap)
Use client-side image map. See the usemap attribute definition in HTML 4.01.

setValue

public void setValue(String value)
When the type attribute of the element has the value "text", "file" or "password", this represents the current contents of the corresponding form control, in an interactive user agent. Changing this attribute changes the contents of the form control, but does not change the value of the HTML value attribute of the element. When the type attribute of the element has the value "button", "hidden", "submit", "reset", "image", "checkbox" or "radio", this represents the HTML value attribute of the element. See the value attribute definition in HTML 4.01.
* Copyright (c) 2003 World Wide Web Consortium, * (Massachusetts Institute of Technology, Institut National de * Recherche en Informatique et en Automatique, Keio University). All * Rights Reserved. This program is distributed under the W3C's Software * Intellectual Property License. This program is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY; without even * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. * See W3C License http://www.w3.org/Consortium/Legal/ for more details.

Overview Package Class Use Source Tree Index Deprecated About