org.w3c.dom.html.HTMLInputElement Maven / Gradle / Ivy
Show all versions of dragome-js-jre Show documentation
/*
GNU LESSER GENERAL PUBLIC LICENSE
Copyright (C) 2006 The Lobo Project
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Contact info: [email protected]
*/
/*
* 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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
public String getAccessKey();
/**
* A single character access key to give access to the form control. See
* the accesskey attribute definition in HTML 4.01.
*/
public void setAccessKey(String accessKey);
/**
* Alternate text for user agents not rendering the normal content of this
* element. See the alt attribute definition in HTML 4.01.
*/
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.
*/
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.
*/
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.
*/
public void setChecked(boolean checked);
/**
* The control is unavailable in this context. See the disabled attribute
* definition in HTML 4.01.
*/
public boolean getDisabled();
/**
* The control is unavailable in this context. See the disabled attribute
* definition in HTML 4.01.
*/
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.
*/
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.
*/
public void setMaxLength(int maxLength);
/**
* Form control or object name when submitted with a form. See the name
* attribute definition in HTML 4.01.
*/
public String getName();
/**
* Form control or object name when submitted with a form. See the name
* attribute definition in HTML 4.01.
*/
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.
*/
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.
*/
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.
* @version DOM Level 2
*/
public int getSize();
/**
* Size information. The precise meaning is specific to each type of
* field. See the size attribute definition in HTML 4.01.
* @version DOM Level 2
*/
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.
*/
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.
*/
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.
*/
public int getTabIndex();
/**
* Index that represents the element's position in the tabbing order. See
* the tabindex attribute definition in HTML 4.01.
*/
public void setTabIndex(int tabIndex);
/**
* The type of control created (all lower case). See the type attribute
* definition in HTML 4.01.
* @version DOM Level 2
*/
public String getType();
/**
* The type of control created (all lower case). See the type attribute
* definition in HTML 4.01.
* @version DOM Level 2
*/
public void setType(String type);
/**
* Use client-side image map. See the usemap attribute definition in HTML
* 4.01.
*/
public String getUseMap();
/**
* Use client-side image map. See the usemap attribute definition in HTML
* 4.01.
*/
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.
*/
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.
*/
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();
}