This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


org.w3c.dom.html
interface HTMLInputElement

All Superinterfaces:
Element, HTMLElement, Node

public interface HTMLInputElement
extends HTMLElement

Form control. Note. 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.0.

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


Field Summary
 
Fields inherited from class 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

          Removes keyboard focus from this element.
 void

          Simulate a mouse-click.
 void

          Gives keyboard focus to this element.
 String

          A comma-separated list of content types that a server processing this form will handle correctly.
 String

          A single character access key to give access to the form control.
 String

          Aligns this object (vertically or horizontally) with respect to its surrounding text.
 String

          Alternate text for user agents not rendering the normal content of this element.
 boolean

          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

          When type has the value "Radio" or "Checkbox", this represents the HTML checked attribute of the element.
 String

          When the type attribute of the element has the value "Text", "File" or "Password", this represents the HTML value attribute of the element.
 boolean

          The control is unavailable in this context.
 HTMLFormElement

          Returns the FORM element containing this control.
 int

          Maximum number of characters for text fields, when type has the value "Text" or "Password".
 String

          Form control or object name when submitted with a form.
 boolean

          This control is read-only.
 String

          Size information.
 String

          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

          Index that represents the element's position in the tabbing order.
 String

          The type of control created.
 String

          Use client-side image map.
 String

          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 the contents of the text area.
 void
setAccept(String accept)

          
 void
setAccessKey(String accessKey)

          
 void

          
 void

          
 void
setChecked(boolean checked)

          
 void
setDefaultChecked(boolean defaultChecked)

          
 void
setDefaultValue(String defaultValue)

          
 void
setDisabled(boolean disabled)

          
 void
setMaxLength(int maxLength)

          
 void

          
 void
setReadOnly(boolean readOnly)

          
 void

          
 void

          
 void
setTabIndex(int tabIndex)

          
 void
setUseMap(String useMap)

          
 void

          
 
Methods inherited from class org.w3c.dom.html.HTMLElement
getClassName, getDir, getId, getLang, getTitle, setClassName, setDir, setId, setLang, setTitle
 
Methods inherited from class org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from class 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 Detail

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


getAccessKey

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


getAlign

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


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


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 value attribute of the element.


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. Changes to this attribute, however, resets the state of the form control. See the checked attribute definition in HTML 4.0.


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. Changing this attribute, however, resets the contents of the form control. See the value attribute definition in HTML 4.0.


getDisabled

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


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


getName

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


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


getSize

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


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


getTabIndex

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


getType

public String getType()
The type of control created. See the type attribute definition in HTML 4.0.


getUseMap

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


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


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)
Parameters:
accept

setAccessKey

public void setAccessKey(String accessKey)
Parameters:
accessKey

setAlign

public void setAlign(String align)
Parameters:
align

setAlt

public void setAlt(String alt)
Parameters:
alt

setChecked

public void setChecked(boolean checked)
Parameters:
checked

setDefaultChecked

public void setDefaultChecked(boolean defaultChecked)
Parameters:
defaultChecked

setDefaultValue

public void setDefaultValue(String defaultValue)
Parameters:
defaultValue

setDisabled

public void setDisabled(boolean disabled)
Parameters:
disabled

setMaxLength

public void setMaxLength(int maxLength)
Parameters:
maxLength

setName

public void setName(String name)
Parameters:
name

setReadOnly

public void setReadOnly(boolean readOnly)
Parameters:
readOnly

setSize

public void setSize(String size)
Parameters:
size

setSrc

public void setSrc(String src)
Parameters:
src

setTabIndex

public void setTabIndex(int tabIndex)
Parameters:
tabIndex

setUseMap

public void setUseMap(String useMap)
Parameters:
useMap

setValue

public void setValue(String value)
Parameters:
value


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.