org.w3c.dom.html.HTMLInputElement Maven / Gradle / Ivy
/*
* Copyright (C) 2005 by Quentin Anciaux
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Library General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* This library 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 the GNU Library General Public License
* for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* @author Quentin Anciaux
*/
package org.w3c.dom.html;
/**
* 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 .
*
*/
public interface HTMLInputElement
extends HTMLElement {
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param defaultValue DOCUMENT ME!
*/
public void setDefaultValue(String defaultValue);
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param defaultChecked DOCUMENT ME!
*/
public void setDefaultChecked(boolean defaultChecked);
/**
* Returns the FORM element containing this control. Returns
* null if this control is not within the context of a form.
*
* @return DOCUMENT ME!
*/
public HTMLFormElement getForm();
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param accept DOCUMENT ME!
*/
public void setAccept(String accept);
/**
* A single character access key to give access to the form control. See
* the accesskey attribute definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
public String getAccessKey();
/**
* A single character access key to give access to the form control. See
* the accesskey attribute definition in HTML 4.01.
*
* @param accessKey DOCUMENT ME!
*/
public void setAccessKey(String accessKey);
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param align DOCUMENT ME!
*/
public void setAlign(String align);
/**
* Alternate text for user agents not rendering the normal content of this
* element. See the alt attribute definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
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.
*
* @param alt DOCUMENT ME!
*/
public void setAlt(String alt);
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param checked DOCUMENT ME!
*/
public void setChecked(boolean checked);
/**
* The control is unavailable in this context. See the disabled attribute
* definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
public boolean getDisabled();
/**
* The control is unavailable in this context. See the disabled attribute
* definition in HTML 4.01.
*
* @param disabled DOCUMENT ME!
*/
public void setDisabled(boolean disabled);
/**
* Maximum number of characters for text fields, when type has
* the value "text" or "password". See the maxlength attribute definition
* in HTML 4.01.
*
* @return DOCUMENT ME!
*/
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.
*
* @param maxLength DOCUMENT ME!
*/
public void setMaxLength(int maxLength);
/**
* Form control or object name when submitted with a form. See the name
* attribute definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
public String getName();
/**
* Form control or object name when submitted with a form. See the name
* attribute definition in HTML 4.01.
*
* @param name DOCUMENT ME!
*/
public void setName(String name);
/**
* This control is read-only. Relevant only when type has the
* value "text" or "password". See the readonly attribute definition in
* HTML 4.01.
*
* @return DOCUMENT ME!
*/
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.
*
* @param readOnly DOCUMENT ME!
*/
public void setReadOnly(boolean readOnly);
/**
* Size information. The precise meaning is specific to each type of field.
* See the size attribute definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
public int getSize();
/**
* Size information. The precise meaning is specific to each type of field.
* See the size attribute definition in HTML 4.01.
*
* @param size DOCUMENT ME!
*/
public void setSize(int size);
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param src DOCUMENT ME!
*/
public void setSrc(String src);
/**
* Index that represents the element's position in the tabbing order. See
* the tabindex attribute definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
public int getTabIndex();
/**
* Index that represents the element's position in the tabbing order. See
* the tabindex attribute definition in HTML 4.01.
*
* @param tabIndex DOCUMENT ME!
*/
public void setTabIndex(int tabIndex);
/**
* The type of control created (all lower case). See the type attribute
* definition in HTML 4.01.
*
* @return DOCUMENT ME!
*/
public String getType();
/**
* The type of control created (all lower case). See the type attribute
* definition in HTML 4.01.
*
* @param type DOCUMENT ME!
*/
public void setType(String type);
/**
* Use client-side image map. See the usemap attribute definition in HTML
* 4.01.
*
* @return DOCUMENT ME!
*/
public String getUseMap();
/**
* Use client-side image map. See the usemap attribute definition in HTML
* 4.01.
*
* @param useMap DOCUMENT ME!
*/
public void setUseMap(String useMap);
/**
* 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.
*
* @return DOCUMENT ME!
*/
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.
*
* @param value DOCUMENT ME!
*/
public void setValue(String value);
/**
* Removes keyboard focus from this element.
*/
public void blur();
/**
* Gives keyboard focus to this element.
*/
public void focus();
/**
* Select the contents of the text area. For INPUT elements
* whose type attribute has one of the following values:
* "text", "file", or "password".
*/
public void select();
/**
* Simulate a mouse-click. For INPUT elements whose
* type attribute has one of the following values: "button",
* "checkbox", "radio", "reset", or "submit".
*/
public void click();
}